Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/justin-p/ansible-role-mailu

Ansible role for Mailu. Mailu is a simple yet full-featured mail server as a set of Docker images.
https://github.com/justin-p/ansible-role-mailu

hacktoberfest

Last synced: 25 days ago
JSON representation

Ansible role for Mailu. Mailu is a simple yet full-featured mail server as a set of Docker images.

Host: GitHub
URL: https://github.com/justin-p/ansible-role-mailu
Owner: justin-p
License: mit
Created: 2021-09-24T09:18:10.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2024-03-19T20:03:02.000Z (8 months ago)
Last Synced: 2024-03-19T21:27:18.396Z (8 months ago)
Topics: hacktoberfest
Language: Jinja
Homepage:
Size: 35.2 KB
Stars: 0
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Ansible-role-mailu

[![Ansible Role Name](https://img.shields.io/ansible/role/d/justin_p/mailu?style=flat-square
)](https://galaxy.ansible.com/justin_p/mailu)
[![Github Actions](https://img.shields.io/github/actions/workflow/status/justin-p/ansible-role-mailu/only_linting.yml?label=Github%20Actions&logo=github&style=flat-square)](https://github.com/justin-p/ansible-role-mailu/actions)

Ansible role for Mailu. Mailu is a simple yet full-featured mail server as a set of Docker images.

## Requirements

docker and docker-compose should be setup on the host.

## Variables

`defaults/main.yml`

| Variable
| -----------------------------------
| mailu_install_path
| mailu_docker_user
| mailu_docker_compose
| mailu_docker_compose_env
| mailu_version
| mailu_docker_subnet
| mailu_dns_ip
| mailu_initial_admin_username
| mailu_initial_admin_password
| mailu_env_file
| mailu_env_api_token
| mailu_env_secret_key
| mailu_env_mail_domain
| mailu_env_hostnames
| mailu_env_postmaster
| mailu_env_tls_flavor
| mailu_env_auth_ratelimit
| mailu_env_opt_out_stats
| mailu_env_admin_interface
| mailu_env_webmail_product
| mailu_env_webdav_product
| mailu_env_antivirus_product
| mailu_env_message_size_limit
| mailu_env_relay_nets
| mailu_env_relay_host
| mailu_env_fetchmail_delay
| mailu_env_recipient_delimiter
| mailu_env_dmarc_rua
| mailu_env_dmarc_ruf
| mailu_env_welcome
| mailu_env_welcome_subject
| mailu_env_welcome_body
| mailu_env_compression
| mailu_env_compression_level
| mailu_env_webroot_redirect
| mailu_env_web_admin_path
| mailu_env_webmail_path
| mailu_env_api_path
| mailu_env_sitename
| mailu_env_website
| mailu_env_compose_project_name
| mailu_env_password_scheme
| mailu_env_real_ip_header
| mailu_env_real_ip_from
| mailu_env_reject_unlisted_recipient
| mailu_env_log_level
| mailu_env_tz
| mailu_env_default_spam_threshold | description | default value | | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | Path to install mailu under | "/mailu" | | User that will be used to run/won the mailu containers | root | | Path to mailu docker-compose template | "{{ role_path }}/templates/docker-compose.yml.j2" | | Path to mailu docker-compose env file | "{{ role_path }}/templates/docker-compose.env.j2" | | Mailu version to use | 1.8 | | Subnet used by docker-compose for mailu | 172.18.0.0/16 | | IP adres that will be used by the resolver container | 172.18.10.10 | | Name for initial account that will be created | admin (will result in username admin@{{ mailu_env_mail_domain }}) | | Password for initial account that will be created | Aasnd3hn7dn3nf7wfnoj84 | | Mailu env file | "{{ role_path }}/templates/`mailu.env.j2`" | | Env file variable, see `mailu.env.j2` template for more info for more info | F1JqJeRr46hPcQZdgn0i | | Env file variable, see `mailu.env.j2` template for more info for more info | CUFJMQHXJJY84WVC | | Env file variable, see `mailu.env.j2` template for more info for more info | example.net | | Env file variable, see `mailu.env.j2` template for more info for more info | mailhost | | Env file variable, see `mailu.env.j2` template for more info for more info | admin | | Env file variable, see `mailu.env.j2` template for more info for more info | notls | | Env file variable, see `mailu.env.j2` template for more info for more info | 10/minute;1000/hour | | Env file variable, see `mailu.env.j2` template for more info for more info | "True" | | Env file variable, see `mailu.env.j2` template for more info for more info | "true" | | Env file variable, see `mailu.env.j2` template for more info for more info | snappymail | | Env file variable, see `mailu.env.j2` template for more info for more info | none | | Env file variable, see `mailu.env.j2` template for more info for more info | none | | Env file variable, see `mailu.env.j2` template for more info for more info | 50000000 | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | 600 | | Env file variable, see `mailu.env.j2` template for more info for more info | + | | Env file variable, see `mailu.env.j2` template for more info for more info | admin | | Env file variable, see `mailu.env.j2` template for more info for more info | admin | | Env file variable, see `mailu.env.j2` template for more info for more info | "false" | | Env file variable, see `mailu.env.j2` template for more info for more info | "Welcome to your new mail account" | | Env file variable, see `mailu.env.j2` template for more info for more info | "Welcome to your new email account, if you can read this, then it is configured properly!" | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | /webmail | | Env file variable, see `mailu.env.j2` template for more info for more info | /admin | | Env file variable, see `mailu.env.j2` template for more info for more info | /webmail | | Env file variable, see `mailu.env.j2` template for more info for more info | /api | | Env file variable, see `mailu.env.j2` template for more info for more info | Mailu | | Env file variable, see `mailu.env.j2` template for more info for more info | https://github.com/justin-p/ | | Env file variable, see `mailu.env.j2` template for more info for more info | mailu | | Env file variable, see `mailu.env.j2` template for more info for more info | BLF-CRYPT | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | | | Env file variable, see `mailu.env.j2` template for more info for more info | WARNING | | Env file variable, see `mailu.env.j2` template for more info for more info | Etc/UTC | | Env file variable, see `mailu.env.j2` template for more info for more info | 80 |

## Dependencies

A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.

## Example Playbook

### Default role installation

```yaml
---
- hosts: mailu_hosts
become: yes
roles:
- role: justin_p.mailu
```

### Deployment playbook

```yaml
---
- hosts: mailu_hosts
become: yes
tasks:
- name: Run 'robertdebock.update_package_cache'-role
ansible.builtin.include_role:
name: robertdebock.update_package_cache

- name: Run 'robertdebock.core_dependencies'-role
ansible.builtin.include_role:
name: robertdebock.core_dependencies

- name: Run 'robertdebock.bootstrap'-role
ansible.builtin.include_role:
name: robertdebock.bootstrap

- name: Run 'robertdebock.epel'-role
ansible.builtin.include_role:
name: robertdebock.epel

- name: Run 'robertdebock.update'-role
ansible.builtin.include_role:
name: robertdebock.update
vars:
update_reboot: false

- name: Run 'robertdebock.firewall'-role
ansible.builtin.include_role:
name: robertdebock.firewall
vars:
firewall_services:
- name: ssh # and other rules for mailu, but you can figure that out yourself.

- name: Run 'robertdebock.hostname'-role
ansible.builtin.include_role:
name: robertdebock.hostname
vars:
hostname: mailhost.domain.tld
hostname_reboot: true

- name: Flush handlers triggered turing bootstrap
meta: flush_handlers

- name: Install and harden docker
include_role:
name: justin_p.bootstrap_docker
vars:
bsd_docker_username: docker_user
bsd_docker_password: StrongPassword01!
bsd_docker_password_salt: SomeSaltsPlease
bsd_docker_iptables_template: "{{ playbook_dir }}/templates/rules.v4.j2"

- name: Flush handlers triggered turing bootstrap_docker
meta: flush_handlers

- name: Install mailu
include_role:
name: justin_p.mailu
vars:
mailu_docker_subnet: "{{ docker_subnet }}" # 172.18.0.0/16
mailu_docker_user: docker_user
mailu_install_path: /home/docker_user/mailu
mailu_env_secret_key: 16_char_random_long_string
mailu_env_hostnames: mailhost.domain.tld
mailu_env_mail_domain: domain.tld
mailu_initial_admin_password: StrongPassword01!
```

## License

MIT

## Authors

Justin Perdok ([@justin-p](https://github.com/justin-p/)), Orange Cyberdefense

## Contributing

Feel free to open issues, contribute and submit your Pull Requests. You can also ping me on Twitter ([@JustinPerdok](https://twitter.com/JustinPerdok))