This commit is contained in:
Jesko Anschütz 2025-03-20 10:39:09 +01:00
commit d563801458
52 changed files with 4216 additions and 0 deletions

0
README.md Normal file
View file

14
install-dockerhost.yml Normal file
View file

@ -0,0 +1,14 @@
- hosts: all
name: Dockerhost installieren
remote_user: root
gather_facts: yes
vars:
with_starship: false
copy_dot_files: false
mailcow__timezone: Europe/Berlin
roles:
- install_docker
- install_oh-my-zsh
- mailcow-ansiblerole

View file

@ -0,0 +1,65 @@
# ---
# tasks file for install_docker
- name: Check if Docker is installed
become: yes
command: docker -v
register: docker_installed
ignore_errors: true
- name: Install Docker
become: yes
block:
- name: Add Docker's official GPG key
block:
- name: Install necessary packages
become: yes
ansible.builtin.apt:
name:
- ca-certificates
- curl
- gnupg
state: latest
update_cache: yes
- name: Add GPG key
ansible.builtin.shell:
cmd: |
install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
chmod a+r /etc/apt/keyrings/docker.asc
- name: Add the repository to Apt sources
block:
- name: Add repos
ansible.builtin.shell:
cmd: |
echo \
"deb [arch="$(dpkg --print-architecture)" signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
"$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
- name: Install Docker packages
become: yes
ansible.builtin.apt:
name:
- docker-ce
- docker-ce-cli
- containerd.io
- docker-buildx-plugin
- docker-compose-plugin
state: latest
update_cache: yes
when: docker_installed.failed
- name: Ensure Docker group exists
become: yes
ansible.builtin.group:
name: docker
state: present
register: docker_group
- name: Add User to docker group
become: yes
ansible.builtin.user:
name: yourUser
groups: docker
append: true
when: docker_group is changed

View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 Lorenzo Bettini
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View file

@ -0,0 +1,66 @@
Role Name
=========
My Ansible role for installing "Oh My Zsh", some of its plug-ins, and other command line tools. It can also install and configure the "starship" prompt or the "p10k" theme.
DISCLAIMER: this role is built to fit my needs and configurations, and it is not meant to be reusable.
This role is described in this blog post: https://www.lorenzobettini.it/2023/07/my-ansible-role-for-oh-my-zsh-and-other-cli-programs/
Role Variables
--------------
By default, it installs the "starship" prompt.
To install, instead, the "p10k" theme, pass the variable `with_starship: false`.
By default, it also copies the dot files (i.e., `.zshrc` and `.p10k` for "p10k").
To disable that, pass the variable `copy_dot_files: false`.
Example Playbook
----------------
For `starship` (default):
```yaml
- name: Install Oh My Zsh
ansible.builtin.include_role:
name: lorenzobettini.oh_my_zsh
```
For `p10k`:
```yaml
- name: Install Oh My Zsh
ansible.builtin.include_role:
name: lorenzobettini.oh_my_zsh
vars:
with_starship: false
copy_dot_files: false
```
Notes
-------
To quickly check `converge` passing a variable:
```
molecule converge -- --extra-vars='with_starship=false'
```
To run a different scenario:
```
molecule converge --scenario-name='p10k-scenario'
```
To run the playbook on this system for `starship` (default):
```
ansible-playbook tests/test.yml -i tests/inventory -K
```
To run the playbook on this system for `p10k`:
```
ansible-playbook tests/test.yml -i tests/inventory -K --extra-vars '{"with_starship":false}'
```

View file

@ -0,0 +1,2 @@
---
# defaults file for oh_my_zsh

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,146 @@
# Enable Powerlevel10k instant prompt. Should stay close to the top of ~/.zshrc.
# Initialization code that may require console input (password prompts, [y/n]
# confirmations, etc.) must go above this block; everything else may go below.
if [[ -r "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh" ]]; then
source "${XDG_CACHE_HOME:-$HOME/.cache}/p10k-instant-prompt-${(%):-%n}.zsh"
fi
# If you come from bash you might have to change your $PATH.
# export PATH=$HOME/bin:/usr/local/bin:$PATH
# Path to your oh-my-zsh installation.
export ZSH="$HOME/.oh-my-zsh"
# Set name of the theme to load --- if set to "random", it will
# load a random theme each time oh-my-zsh is loaded, in which case,
# to know which specific one was loaded, run: echo $RANDOM_THEME
# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
ZSH_THEME="powerlevel10k/powerlevel10k"
# Set list of themes to pick from when loading at random
# Setting this variable when ZSH_THEME=random will cause zsh to load
# a theme from this variable instead of looking in $ZSH/themes/
# If set to an empty array, this variable will have no effect.
# ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" )
# Uncomment the following line to use case-sensitive completion.
# CASE_SENSITIVE="true"
# Uncomment the following line to use hyphen-insensitive completion.
# Case-sensitive completion must be off. _ and - will be interchangeable.
# HYPHEN_INSENSITIVE="true"
# Uncomment one of the following lines to change the auto-update behavior
# zstyle ':omz:update' mode disabled # disable automatic updates
# zstyle ':omz:update' mode auto # update automatically without asking
# zstyle ':omz:update' mode reminder # just remind me to update when it's time
# Uncomment the following line to change how often to auto-update (in days).
# zstyle ':omz:update' frequency 13
# Uncomment the following line if pasting URLs and other text is messed up.
# DISABLE_MAGIC_FUNCTIONS="true"
# Uncomment the following line to disable colors in ls.
# DISABLE_LS_COLORS="true"
# Uncomment the following line to disable auto-setting terminal title.
# DISABLE_AUTO_TITLE="true"
# Uncomment the following line to enable command auto-correction.
# ENABLE_CORRECTION="true"
# Uncomment the following line to display red dots whilst waiting for completion.
# You can also set it to another string to have that shown instead of the default red dots.
# e.g. COMPLETION_WAITING_DOTS="%F{yellow}waiting...%f"
# Caution: this setting can cause issues with multiline prompts in zsh < 5.7.1 (see #5765)
# COMPLETION_WAITING_DOTS="true"
# Uncomment the following line if you want to disable marking untracked files
# under VCS as dirty. This makes repository status check for large repositories
# much, much faster.
# DISABLE_UNTRACKED_FILES_DIRTY="true"
# Uncomment the following line if you want to change the command execution time
# stamp shown in the history command output.
# You can set one of the optional three formats:
# "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd"
# or set a custom format using the strftime function format specifications,
# see 'man strftime' for details.
# HIST_STAMPS="mm/dd/yyyy"
# Would you like to use another custom folder than $ZSH/custom?
# ZSH_CUSTOM=/path/to/new-custom-folder
# Which plugins would you like to load?
# Standard plugins can be found in $ZSH/plugins/
# Custom plugins may be added to $ZSH_CUSTOM/plugins/
# Example format: plugins=(rails git textmate ruby lighthouse)
# Add wisely, as too many plugins slow down shell startup.
plugins=(
git
aliases
branch
github
zsh-autosuggestions
zsh-syntax-highlighting
zsh-completions
zsh-interactive-cd
zsh-navigation-tools
fzf
zoxide
autoupdate
)
source $ZSH/oh-my-zsh.sh
# Aliases with eza
alias l='eza -lah --color=always --icons --group-directories-first' # with headers
alias la='eza -al --color=always --icons --group-directories-first' # all files and dirs
alias ll='eza -l --color=always --icons --group-directories-first' # long format
alias lt='eza -aT --color=always --icons --group-directories-first' # tree listing
# Aliases with fzf: with preview
alias fzp="fzf --preview 'bat --style=numbers --color=always --line-range :500 {}'"
# User configuration
# Make sure $HOME/.local/bin is in the PATH
export PATH=$HOME/.local/bin:$PATH
export _JAVA_OPTIONS=-Djava.net.preferIPv4Stack=true
# For Homebrew, if installed
export HOMEBREW_PREFIX="/home/linuxbrew/.linuxbrew";
export HOMEBREW_CELLAR="/home/linuxbrew/.linuxbrew/Cellar";
export HOMEBREW_REPOSITORY="/home/linuxbrew/.linuxbrew/Homebrew";
export PATH="/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin${PATH+:$PATH}";
export MANPATH="/home/linuxbrew/.linuxbrew/share/man${MANPATH+:$MANPATH}:";
export INFOPATH="/home/linuxbrew/.linuxbrew/share/info:${INFOPATH:-}";
# export MANPATH="/usr/local/man:$MANPATH"
# You may need to manually set your language environment
# export LANG=en_US.UTF-8
# Preferred editor for local and remote sessions
# if [[ -n $SSH_CONNECTION ]]; then
# export EDITOR='vim'
# else
# export EDITOR='mvim'
# fi
# Compilation flags
# export ARCHFLAGS="-arch x86_64"
# Set personal aliases, overriding those provided by oh-my-zsh libs,
# plugins, and themes. Aliases can be placed here, though oh-my-zsh
# users are encouraged to define aliases within the ZSH_CUSTOM folder.
# For a full list of active aliases, run `alias`.
#
# Example aliases
# alias zshconfig="mate ~/.zshrc"
# alias ohmyzsh="mate ~/.oh-my-zsh"
# To customize prompt, run `p10k configure` or edit ~/.p10k.zsh.
[[ ! -f ~/.p10k.zsh ]] || source ~/.p10k.zsh

View file

@ -0,0 +1,139 @@
# If you come from bash you might have to change your $PATH.
# export PATH=$HOME/bin:/usr/local/bin:$PATH
# Path to your oh-my-zsh installation.
export ZSH="$HOME/.oh-my-zsh"
# Set name of the theme to load --- if set to "random", it will
# load a random theme each time oh-my-zsh is loaded, in which case,
# to know which specific one was loaded, run: echo $RANDOM_THEME
# See https://github.com/ohmyzsh/ohmyzsh/wiki/Themes
ZSH_THEME=""
# Since we use starship
# Set list of themes to pick from when loading at random
# Setting this variable when ZSH_THEME=random will cause zsh to load
# a theme from this variable instead of looking in $ZSH/themes/
# If set to an empty array, this variable will have no effect.
# ZSH_THEME_RANDOM_CANDIDATES=( "robbyrussell" "agnoster" )
# Uncomment the following line to use case-sensitive completion.
# CASE_SENSITIVE="true"
# Uncomment the following line to use hyphen-insensitive completion.
# Case-sensitive completion must be off. _ and - will be interchangeable.
# HYPHEN_INSENSITIVE="true"
# Uncomment one of the following lines to change the auto-update behavior
# zstyle ':omz:update' mode disabled # disable automatic updates
# zstyle ':omz:update' mode auto # update automatically without asking
# zstyle ':omz:update' mode reminder # just remind me to update when it's time
# Uncomment the following line to change how often to auto-update (in days).
# zstyle ':omz:update' frequency 13
# Uncomment the following line if pasting URLs and other text is messed up.
# DISABLE_MAGIC_FUNCTIONS="true"
# Uncomment the following line to disable colors in ls.
# DISABLE_LS_COLORS="true"
# Uncomment the following line to disable auto-setting terminal title.
# DISABLE_AUTO_TITLE="true"
# Uncomment the following line to enable command auto-correction.
# ENABLE_CORRECTION="true"
# Uncomment the following line to display red dots whilst waiting for completion.
# You can also set it to another string to have that shown instead of the default red dots.
# e.g. COMPLETION_WAITING_DOTS="%F{yellow}waiting...%f"
# Caution: this setting can cause issues with multiline prompts in zsh < 5.7.1 (see #5765)
# COMPLETION_WAITING_DOTS="true"
# Uncomment the following line if you want to disable marking untracked files
# under VCS as dirty. This makes repository status check for large repositories
# much, much faster.
# DISABLE_UNTRACKED_FILES_DIRTY="true"
# Uncomment the following line if you want to change the command execution time
# stamp shown in the history command output.
# You can set one of the optional three formats:
# "mm/dd/yyyy"|"dd.mm.yyyy"|"yyyy-mm-dd"
# or set a custom format using the strftime function format specifications,
# see 'man strftime' for details.
# HIST_STAMPS="mm/dd/yyyy"
# Would you like to use another custom folder than $ZSH/custom?
# ZSH_CUSTOM=/path/to/new-custom-folder
# Which plugins would you like to load?
# Standard plugins can be found in $ZSH/plugins/
# Custom plugins may be added to $ZSH_CUSTOM/plugins/
# Example format: plugins=(rails git textmate ruby lighthouse)
# Add wisely, as too many plugins slow down shell startup.
plugins=(
git
aliases
branch
github
zsh-autosuggestions
zsh-syntax-highlighting
zsh-completions
zsh-interactive-cd
zsh-navigation-tools
fzf
zoxide
autoupdate
)
source $ZSH/oh-my-zsh.sh
# Aliases with eza
alias l='eza -lah --color=always --icons --group-directories-first' # with headers
alias la='eza -al --color=always --icons --group-directories-first' # all files and dirs
alias ll='eza -l --color=always --icons --group-directories-first' # long format
alias lt='eza -aT --color=always --icons --group-directories-first' # tree listing
# Aliases with fzf: with preview
alias fzp="fzf --preview 'bat --style=numbers --color=always --line-range :500 {}'"
# User configuration
# Make sure $HOME/.local/bin is in the PATH
export PATH=$HOME/.local/bin:$PATH
export _JAVA_OPTIONS=-Djava.net.preferIPv4Stack=true
# For Homebrew, if installed
export HOMEBREW_PREFIX="/home/linuxbrew/.linuxbrew";
export HOMEBREW_CELLAR="/home/linuxbrew/.linuxbrew/Cellar";
export HOMEBREW_REPOSITORY="/home/linuxbrew/.linuxbrew/Homebrew";
export PATH="/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin${PATH+:$PATH}";
export MANPATH="/home/linuxbrew/.linuxbrew/share/man${MANPATH+:$MANPATH}:";
export INFOPATH="/home/linuxbrew/.linuxbrew/share/info:${INFOPATH:-}";
# export MANPATH="/usr/local/man:$MANPATH"
# You may need to manually set your language environment
# export LANG=en_US.UTF-8
# Preferred editor for local and remote sessions
# if [[ -n $SSH_CONNECTION ]]; then
# export EDITOR='vim'
# else
# export EDITOR='mvim'
# fi
# Compilation flags
# export ARCHFLAGS="-arch x86_64"
# Set personal aliases, overriding those provided by oh-my-zsh libs,
# plugins, and themes. Aliases can be placed here, though oh-my-zsh
# users are encouraged to define aliases within the ZSH_CUSTOM folder.
# For a full list of active aliases, run `alias`.
#
# Example aliases
# alias zshconfig="mate ~/.zshrc"
# alias ohmyzsh="mate ~/.oh-my-zsh"
eval "$(starship init zsh)"

View file

@ -0,0 +1,2 @@
---
# handlers file for oh_my_zsh

View file

@ -0,0 +1,31 @@
galaxy_info:
role_name: oh_my_zsh
author: Lorenzo Bettini
namespace: lorenzobettini
description: An Ansible/Molecule example for installing Oh My Zsh
company: Lorenzo Bettini
license: "license MIT"
min_ansible_version: '2.1'
platforms:
- name: Fedora
versions:
- all
- name: Ubuntu
versions:
- all
- name: ArchLinux
versions:
- all
galaxy_tags: []
# List tags for your role here, one per line. A tag is a keyword that describes
# and categorizes the role. Users find roles by searching for tags. Be sure to
# remove the '[]' above, if you add tags to this list.
#
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.

View file

@ -0,0 +1,18 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance-arch
image: archlinux:latest
pre_build_image: true
provisioner:
name: ansible
playbooks:
converge: ../shared/converge.yml
verify: ../shared/verify.yml

View file

@ -0,0 +1,9 @@
---
- name: Prepare
hosts: all
gather_facts: false
tasks:
- name: Install python in Arch
# -u is crucial to avoid partial updates and inconsistent libraries
ansible.builtin.raw: pacman -Syu --noconfirm --needed python sudo
changed_when: false

View file

@ -0,0 +1,18 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance-fedora
image: fedora:40
pre_build_image: true
provisioner:
name: ansible
playbooks:
converge: ../shared/converge.yml
verify: ../shared/verify.yml

View file

@ -0,0 +1,10 @@
---
- name: Converge
hosts: all
tasks:
- name: "Include lorenzobettini.oh_my_zsh"
ansible.builtin.include_role:
name: "lorenzobettini.oh_my_zsh"
vars:
with_starship: false
copy_dot_files: false

View file

@ -0,0 +1,19 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance
image: ${MOLECULE_DISTRO:-archlinux:latest}
pre_build_image: true
provisioner:
name: ansible
playbooks:
prepare: ../default/prepare.yml
verifier:
name: ansible

View file

@ -0,0 +1,95 @@
---
# This is an example playbook to execute Ansible tests.
- name: Verify
hosts: all
gather_facts: true
tasks:
- name: Get current user's shell
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $7 }'
register: user_shell
args:
executable: /bin/bash
changed_when: false
- name: Assert shell is zsh
ansible.builtin.assert:
that: "user_shell.stdout == '/bin/zsh'"
- name: Assert starship is NOT installed in this scenario
ansible.builtin.shell: >
starship --version
register: starship_cmd
failed_when: starship_cmd.rc == 0
changed_when: false
# In Ubuntu we have to create a link to "fd", because
# the command is "fdfind", so it's better to check that
- name: Assert fd can be found
ansible.builtin.shell: >
fd --version
changed_when: false
# In Ubuntu we have to create a link to "bat", because
# the command is "batcat", so it's better to check that
- name: Assert bat can be found
ansible.builtin.shell: >
bat --version
changed_when: false
# In Ubuntu/Fedora we have to install it from archive
# so it's better to check that
- name: Assert dust can be found
ansible.builtin.shell: >
dust --version
changed_when: false
# In Ubuntu we have to install it from archive
# so it's better to check that
- name: Assert procs can be found
ansible.builtin.shell: >
procs --version
changed_when: false
# In Ubuntu we have to install it from a repository
# so it's better to check that
- name: Assert eza can be found
ansible.builtin.shell: >
eza --version
changed_when: false
# In Ubuntu Focal we have to install it from archive
# so it's better to check that
- name: Assert zoxide can be found
ansible.builtin.shell: >
zoxide --version
changed_when: false
- name: Get current user's home
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $6 }'
register: user_home
args:
executable: /bin/bash
changed_when: false
- name: Check if ~/.p10k.zsh is present
ansible.builtin.stat:
path: "{{ user_home.stdout }}/.p10k.zsh"
register: result
- name: Assert ~/.p10k.zsh is NOT present in this scenario
ansible.builtin.assert:
that: "not result.stat.exists"
- name: Check if ~/.zshrc is present
ansible.builtin.stat:
path: "{{ user_home.stdout }}/.zshrc"
register: result
- name: Assert ~/.zshrc is NOT present in this scenario
ansible.builtin.assert:
that: "not result.stat.exists"

View file

@ -0,0 +1,9 @@
---
- name: Converge
hosts: all
tasks:
- name: "Include lorenzobettini.oh_my_zsh"
ansible.builtin.include_role:
name: "lorenzobettini.oh_my_zsh"
vars:
with_starship: false

View file

@ -0,0 +1,19 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance
image: ${MOLECULE_DISTRO:-archlinux:latest}
pre_build_image: true
provisioner:
name: ansible
playbooks:
prepare: ../default/prepare.yml
verifier:
name: ansible

View file

@ -0,0 +1,86 @@
---
# This is an example playbook to execute Ansible tests.
- name: Verify
hosts: all
gather_facts: true
tasks:
- name: Get current user's shell
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $7 }'
register: user_shell
args:
executable: /bin/bash
changed_when: false
- name: Assert shell is zsh
ansible.builtin.assert:
that: "user_shell.stdout == '/bin/zsh'"
- name: Assert starship is NOT installed in this scenario
ansible.builtin.shell: >
starship --version
register: starship_cmd
failed_when: starship_cmd.rc == 0
changed_when: false
# In Ubuntu we have to create a link to "fd", because
# the command is "fdfind", so it's better to check that
- name: Assert fd can be found
ansible.builtin.shell: >
fd --version
changed_when: false
# In Ubuntu we have to create a link to "bat", because
# the command is "batcat", so it's better to check that
- name: Assert bat can be found
ansible.builtin.shell: >
bat --version
changed_when: false
# In Ubuntu/Fedora we have to install it from archive
# so it's better to check that
- name: Assert dust can be found
ansible.builtin.shell: >
dust --version
changed_when: false
# In Ubuntu we have to install it from archive
# so it's better to check that
- name: Assert procs can be found
ansible.builtin.shell: >
procs --version
changed_when: false
# In Ubuntu we have to install it from a repository
# so it's better to check that
- name: Assert eza can be found
ansible.builtin.shell: >
eza --version
changed_when: false
# In Ubuntu Focal we have to install it from archive
# so it's better to check that
- name: Assert zoxide can be found
ansible.builtin.shell: >
zoxide --version
changed_when: false
- name: Get current user's home
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $6 }'
register: user_home
args:
executable: /bin/bash
changed_when: false
- name: Check if ~/.p10k.zsh is present
ansible.builtin.stat:
path: "{{ user_home.stdout }}/.p10k.zsh"
register: result
- name: Assert ~/.p10k.zsh is present
ansible.builtin.assert:
that: "result.stat.exists"

View file

@ -0,0 +1,7 @@
---
- name: Converge
hosts: all
tasks:
- name: "Include lorenzobettini.oh_my_zsh"
ansible.builtin.include_role:
name: "lorenzobettini.oh_my_zsh"

View file

@ -0,0 +1,82 @@
---
- name: Verify
hosts: all
gather_facts: true
tasks:
- name: Get current user's shell
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $7 }'
register: user_shell
args:
executable: /bin/bash
changed_when: false
- name: Assert shell is zsh
ansible.builtin.assert:
that: "user_shell.stdout == '/bin/zsh'"
- name: Assert starship is installed in this scenario
ansible.builtin.shell: >
starship --version
changed_when: false
# In Ubuntu we have to create a link to "fd", because
# the command is "fdfind", so it's better to check that
- name: Assert fd can be found
ansible.builtin.shell: >
fd --version
changed_when: false
# In Ubuntu we have to create a link to "bat", because
# the command is "batcat", so it's better to check that
- name: Assert bat can be found
ansible.builtin.shell: >
bat --version
changed_when: false
# In Ubuntu/Fedora we have to install it from archive
# so it's better to check that
- name: Assert dust can be found
ansible.builtin.shell: >
dust --version
changed_when: false
# In Ubuntu we have to install it from archive
# so it's better to check that
- name: Assert procs can be found
ansible.builtin.shell: >
procs --version
changed_when: false
# In Ubuntu we have to install it from a repository
# so it's better to check that
- name: Assert eza can be found
ansible.builtin.shell: >
eza --version
changed_when: false
# In Ubuntu Focal we have to install it from archive
# so it's better to check that
- name: Assert zoxide can be found
ansible.builtin.shell: >
zoxide --version
changed_when: false
- name: Get current user's home
ansible.builtin.shell: >
set -o pipefail && \
grep -E "^{{ ansible_user_id }}:" /etc/passwd | awk -F: '{ print $6 }'
register: user_home
args:
executable: /bin/bash
changed_when: false
- name: Check if ~/.p10k.zsh is present
ansible.builtin.stat:
path: "{{ user_home.stdout }}/.p10k.zsh"
register: result
- name: Assert ~/.p10k.zsh is NOT present in this scenario
ansible.builtin.assert:
that: "not result.stat.exists"

View file

@ -0,0 +1,18 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance-ubuntu-focal
image: ubuntu:focal
pre_build_image: true
provisioner:
name: ansible
playbooks:
converge: ../shared/converge.yml
verify: ../shared/verify.yml

View file

@ -0,0 +1,8 @@
---
- name: Prepare
hosts: all
gather_facts: false
tasks:
- name: Install python in Ubuntu
ansible.builtin.raw: apt update && apt install -y --no-install-recommends python3 sudo
changed_when: false

View file

@ -0,0 +1,18 @@
---
dependency:
name: galaxy
driver:
name: docker
lint: |
set -e
yamllint .
ansible-lint
platforms:
- name: instance-ubuntu
image: ubuntu:24.04
pre_build_image: true
provisioner:
name: ansible
playbooks:
converge: ../shared/converge.yml
verify: ../shared/verify.yml

View file

@ -0,0 +1,8 @@
---
- name: Prepare
hosts: all
gather_facts: false
tasks:
- name: Install python in Ubuntu
ansible.builtin.raw: apt update && apt install -y --no-install-recommends python3 sudo
changed_when: false

View file

@ -0,0 +1,5 @@
ansible
molecule
molecule-plugins[docker]
yamllint
ansible-lint

View file

@ -0,0 +1,256 @@
---
# tasks file for oh_my_zsh
- name: Install Git
become: true
ansible.builtin.package:
state: present
name: git
- name: Install ZSH
become: true
ansible.builtin.package:
name: zsh
state: present
- name: Override powerline fonts package name for Debian.
ansible.builtin.set_fact:
powerlinefonts: fonts-powerline
when: ansible_os_family == 'Debian'
- name: Override fd-find package name for Archlinux.
ansible.builtin.set_fact:
fdfind: fd
when: ansible_os_family == 'Archlinux'
- name: Install Powerline fonts
become: true
ansible.builtin.package:
state: present
name: "{{ powerlinefonts }}"
- name: Install ripgrep
become: true
ansible.builtin.package:
state: present
name: ripgrep
- name: Install procs in Arch/Fedora
become: true
ansible.builtin.package:
state: present
name: procs
when: ansible_os_family != 'Debian'
# unzip is useful for extracting zips
- name: Install unzip
become: true
ansible.builtin.package:
state: present
name: unzip
- name: Install procs in Ubuntu
become: true
ansible.builtin.unarchive:
src: "https://github.com/dalance/procs/releases/download/{{ procsversion }}/procs-{{ procsversion }}-x86_64-linux.zip"
dest: /usr/local/bin
remote_src: true
when: ansible_os_family == 'Debian'
- name: Install dust on Arch
become: true
ansible.builtin.package:
state: present
name: dust
when: ansible_os_family == 'Archlinux'
# We soon hit the "API rate limit exceeded" error on GitHub Actions
# so we cannot use {{ dustdata.json.tag_name }} in the next task's URL
# https://github.com/bootandy/dust/releases/latest/download/dust-{{ dustdata.json.tag_name }}-x86_64-unknown-linux-gnu.tar.gz
# we'll have to stick with a fixed version
# - name: Get latest version of dust on Ubuntu/Fedora
# ansible.builtin.uri:
# url: https://api.github.com/repos/bootandy/dust/releases/latest
# method: GET
# return_content: true
# body_format: json
# register: dustdata
# when: ansible_os_family != 'Archlinux'
# In Ubuntu/Fedora we have to install it from archive
# so it's better to check if it's already installed
- name: Check if dust is already installed on Ubuntu/Fedora
ansible.builtin.shell: >
dust --version
register: dust_rc
failed_when: false
changed_when: false
when: ansible_os_family != 'Archlinux'
- name: Install dust on Ubuntu/Fedora
become: true
ansible.builtin.unarchive:
src: "https://github.com/bootandy/dust/releases/download/{{ dustversion }}/dust-{{ dustversion }}-x86_64-unknown-linux-gnu.tar.gz"
dest: /usr/local/bin
extra_opts:
- --strip=1
- --wildcards
- '*/dust'
remote_src: true
when: ansible_os_family != 'Archlinux' and dust_rc.rc != 0
- name: Install Google Noto emoji fonts
become: true
ansible.builtin.package:
state: present
name: noto-fonts-emoji
when: ansible_os_family == 'Archlinux'
# To get "icons" in ezaoutput
- name: Install Patched font Arimo from nerd-fonts (Arch)
become: true
ansible.builtin.package:
state: present
name: ttf-arimo-nerd
when: ansible_os_family == 'Archlinux'
# Required for the Ubuntu repository (see below)
- name: Install GPG and Wget in Ubuntu
become: true
ansible.builtin.package:
state: present
name:
- gpg
- wget
when: ansible_os_family == 'Debian'
# In Ubuntu we have to install it from another repository
# so it's better to check if it's already installed
- name: Check if eza is already installed on Ubuntu
ansible.builtin.shell: >
eza --version
register: eza_rc
failed_when: false
changed_when: false
when: ansible_os_family == 'Debian'
- name: Repository for eza on Ubuntu
become: true
ansible.builtin.shell: |
mkdir -p /etc/apt/keyrings
wget -qO- https://raw.githubusercontent.com/eza-community/eza/main/deb.asc | gpg --dearmor -o /etc/apt/keyrings/gierens.gpg
echo "deb [signed-by=/etc/apt/keyrings/gierens.gpg] http://deb.gierens.de stable main" | tee /etc/apt/sources.list.d/gierens.list
chmod 644 /etc/apt/keyrings/gierens.gpg /etc/apt/sources.list.d/gierens.list
apt update
when: ansible_os_family == 'Debian' and eza_rc.rc != 0
- name: Install eza through package manager
become: true
ansible.builtin.package:
state: present
name: eza
- name: Install fd-find
become: true
ansible.builtin.package:
state: present
name: "{{ fdfind }}"
- name: Create link fd to fdfind in Debian
become: true
ansible.builtin.file:
src: '/usr/bin/fdfind'
dest: '/usr/bin/fd'
state: link
when: ansible_os_family == 'Debian'
- name: Install bat
become: true
ansible.builtin.package:
state: present
name: bat
- name: Create link bat to batcat in Debian
become: true
ansible.builtin.file:
src: '/usr/bin/batcat'
dest: '/usr/bin/bat'
state: link
when: ansible_os_family == 'Debian'
# and ansible_distribution_version is version('23.04', '<')
# In Ubuntu Focal we have to install it from archive
# so it's better to check if it's already installed
- name: Check if zoxide is already installed on Ubuntu Focal
ansible.builtin.shell: >
zoxide --version
register: zoxide_rc
failed_when: false
changed_when: false
when: ansible_os_family == 'Debian' and ansible_distribution_version is version('20.10', '<')
- name: Install zoxide on Ubuntu Focal
become: true
ansible.builtin.unarchive:
src: "https://github.com/ajeetdsouza/zoxide/releases/download/v{{ zoxideversion }}/zoxide-{{ zoxideversion }}-x86_64-unknown-linux-musl.tar.gz"
dest: /usr/local/bin
remote_src: true
when: ansible_os_family == 'Debian' and ansible_distribution_version is version('20.10', '<') and zoxide_rc.rc != 0
- name: Install zoxide through package manager
become: true
ansible.builtin.package:
state: present
name: zoxide
when: ansible_os_family != 'Debian' or ansible_distribution_version is version('20.10', '>=')
# required by the OMZ plugin zsh-interactive-cd
- name: Install fzf (command-line fuzzy finder)
become: true
ansible.builtin.package:
state: present
name: fzf
- name: Install Oh My Zsh # noqa: latest
ansible.builtin.git:
repo: https://github.com/ohmyzsh/ohmyzsh.git
dest: ~/.oh-my-zsh
depth: 1
- name: Install zsh-autosuggestions plugin # noqa: latest
ansible.builtin.git:
repo: https://github.com/zsh-users/zsh-autosuggestions
dest: ~/.oh-my-zsh/custom/plugins/zsh-autosuggestions
depth: 1
- name: Install zsh-completions plugin # noqa: latest
ansible.builtin.git:
repo: https://github.com/zsh-users/zsh-completions
dest: ~/.oh-my-zsh/custom/plugins/zsh-completions
depth: 1
- name: Install zsh-syntax-highlighting plugin # noqa: latest
ansible.builtin.git:
repo: https://github.com/zsh-users/zsh-syntax-highlighting.git
dest: ~/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting
depth: 1
- name: Install autoupdate-zsh-plugin # noqa: latest
ansible.builtin.git:
repo: https://github.com/TamCore/autoupdate-oh-my-zsh-plugins
dest: ~/.oh-my-zsh/custom/plugins/autoupdate
depth: 1
- name: Change user shell to zsh
become: true
ansible.builtin.user:
name: "{{ ansible_user_id }}"
shell: /bin/zsh
- name: Tasks for starship
ansible.builtin.include_tasks: starship.yml
when: with_starship
- name: Tasks for p10k
ansible.builtin.include_tasks: p10k.yml
when: not with_starship

View file

@ -0,0 +1,21 @@
---
# tasks file for p10k
- name: Install Powerline10k theme # noqa: latest
ansible.builtin.git:
repo: https://github.com/romkatv/powerlevel10k.git
dest: ~/.oh-my-zsh/custom/themes/powerlevel10k
depth: 1
- name: Copy zshrc (for p10k)
ansible.builtin.copy:
src: zshrc-p10k
dest: ~/.zshrc
mode: 0644
when: copy_dot_files
- name: Copy p10k.zsh
ansible.builtin.copy:
src: p10k.zsh
dest: ~/.p10k.zsh
mode: 0644
when: copy_dot_files

View file

@ -0,0 +1,40 @@
---
# tasks file for starship
- name: Install starship (cross-shell prompt) as a package
become: true
ansible.builtin.package:
state: present
name: starship
when: ansible_os_family == 'Archlinux'
- name: Install curl (for starship installation)
become: true
ansible.builtin.package:
state: present
name: curl
when: ansible_os_family != 'Archlinux'
- name: Get starship install script
ansible.builtin.get_url:
url: https://starship.rs/install.sh
dest: /tmp/starship_install.sh
mode: '0755'
register: starship_installation_script
when: ansible_os_family != 'Archlinux'
- name: Install starship with installation script
become: true
ansible.builtin.shell:
cmd: /tmp/starship_install.sh --yes
executable: /bin/sh
when: ansible_os_family != 'Archlinux' and starship_installation_script.changed
# if the previous task hasn't changed, the shell script is already there
# and we have already installed starship
# we check this to satisfy idempotence
- name: Copy zshrc (for starship)
ansible.builtin.copy:
src: zshrc-starship
dest: ~/.zshrc
mode: 0644
when: copy_dot_files

View file

@ -0,0 +1 @@
localhost ansible_connection=local

View file

@ -0,0 +1,5 @@
---
- name: Test the role locally
hosts: all
roles:
- ../../

View file

@ -0,0 +1,10 @@
---
# vars file for oh_my_zsh
powerlinefonts: powerline-fonts
fdfind: fd-find
dustversion: v0.8.3
exaversion: v0.10.1
zoxideversion: 0.9.1
procsversion: v0.13.3
with_starship: true
copy_dot_files: true

View file

@ -0,0 +1,4 @@
skip_list:
- '106'
- fqcn-builtins
- experimental

View file

@ -0,0 +1,13 @@
# http://editorconfig.org
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.yml]
indent_style = space
indent_size = 2

4
roles/mailcow-ansiblerole/.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
*.iml
.idea
.vscode/*
.tests/*

View file

@ -0,0 +1,33 @@
---
# Based on ansible-lint config
extends: default
rules:
braces:
max-spaces-inside: 1
level: error
brackets:
max-spaces-inside: 1
level: error
colons:
max-spaces-after: -1
level: error
commas:
max-spaces-after: -1
level: error
comments: disable
comments-indentation: disable
document-start: disable
empty-lines:
max: 3
level: error
hyphens:
level: error
indentation: disable
key-duplicates: enable
line-length: disable
new-line-at-end-of-file: disable
new-lines:
type: unix
trailing-spaces: disable
truthy: disable

View file

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

View file

@ -0,0 +1,89 @@
# mailcow: dockerized - Ansible role 🐮 + 🐋 = 💕
This role will setup a mailcow dockerized email server.
## Prerequisites
- Up and running Ubuntu/Debian host (other distributions not supported/tested for now)
- Docker Compose v2 is required!
## Requirements
| Requirements | Description |
| -------------- | -------------------------------------- |
| docker ce | Docker has to be installed on the host |
| docker-compose | docker-compose is needed |
## Notes
This role will use by default the `inventory_hostname` as mailcow hostname, this means that you have to use the full qualified domain name as your inventory hostname e.g. `mail.mailcow.tld` or you set `mailcow__hostname` to the correct FQDN.
## Variables
| name | purpose | default value | note |
| :---------------------------------------: | :-------------------------------------------------------------------------: | :-------------------------------------------------: | :-----------------------------------------------------------: |
| `mailcow__hostname ` | sets MAILCOW_HOSTNAME | `inventory_hostname` | needs to be an full qualified domain name |
| `mailcow__install_path` | sets the path where the mailcow-dockerized repo will be cloned | `/opt/mailcow-dockerized` | |
| `mailcow__git_repo` | Get mailcow from a specific repository | `https://github.com/mailcow/mailcow-dockerized.git` | |
| `mailcow__git_version` | checkout a specific version of mailcow | `master` | |
| `mailcow__timezone` | used to set the timezone your mailcow runs in during the config generation | not set | **must be set** |
| `mailcow__docker_compose_project_name` | sets the docker-compose projectname to a user-defined string | `mailcowdockerized` | |
| `mailcow__theme` | set the default mailcow theme in vars.local.inc.php | `lumen` | |
| `mailcow__config_http_port` | sets HTTP_PORT in mailcow.conf | `80` | |
| `mailcow__config_http_bind` | sets HTTP_BIND in mailcow.conf | `none` | |
| `mailcow__config_https_port` | sets HTTPS_PORT in mailcow.conf | `443` | |
| `mailcow__config_https_bind` | sets HTTPS_BIND in mailcow.conf | `none` | |
| `mailcow__config_acl_anyone` | sets ACL_ANYONE | disallow | |
| `mailcow__config_maildir_gc_time` | sets MAILDIR_GC_TIME in mailcow.conf | `1440` | |
| `mailcow__config_additional_san` | sets ADDITIONAL_SAN in mailcow.conf | | needs to be a list |
| `mailcow__config_additional_server_names` | sets ADDITIONAL_SERVER_NAMES in mailcow.conf | | needs to be a list |
| `mailcow__config_skip_lets_encrypt` | sets SKIP_LETS_ENCRYPT in mailcow.conf | | |
| `mailcow__config_enable_ssl_sni` | sets ENABLE_SSL_SNI in mailcow.conf | | |
| `mailcow__config_skip_ip_check` | sets SKIP_IP_CHECK in mailcow.conf | | |
| `mailcow__config_skip_http_verification` | sets SKIP_HTTP_VERIFICATION in mailcow.conf | `n` | |
| `mailcow__config_skip_clamd` | sets SKIP_CLAMD in mailcow.conf | `n` | |
| `mailcow__config_skip_fts` | sets SKIP_FTS in mailcow.conf | `n` | disables Full-text search (flatcurve) |
| `mailcow__config_fts_heap` | sets FTS_HEAP in mailcow.conf | `128` | sets the max amount of ram per index worker |
| `mailcow__config_fts_procs` | sets FTS_PROCS in mailcow.conf | `1` | amount of indexing processes max. running |
| `mailcow__config_skip_sogo` | sets SKIP_SOGO in mailcow.conf | `n` | |
| `mailcow__config_http_redirect` | sets HTTP_REDIRECT in mailcow.conf to control HTTP Redirects | `n` | can be `y` or `n` |
| `mailcow__config_allow_admin_email_login` | sets ALLOW_ADMIN_EMAIL_LOGIN in mailcow.conf | `n` | |
| `mailcow__config_use_watchdog` | sets USE_WATCHDOG in mailcow.conf | `n` | |
| `mailcow__config_watchdog_notify_email` | sets WATCHDOG_NOTIFY_EMAIL in mailcow.conf | | |
| `mailcow__config_watchdog_notify_ban` | sets WATCHDOG_NOTIFY_BAN in mailcow.conf | `y` | |
| `mailcow__config_watchdog_subject` | sets WATCHDOG_SUBJECT in mailcow.conf | `Watchdog ALERT` | |
| `mailcow__config_log_lines` | sets LOG_LINES in mailcow.conf | `9999` | |
| `mailcow__config_sogo_expire_session` | sets SOGO_EXPIRE_SESSION in mailcow.conf | `480` | |
| `mailcow__install_updates` | if `yes` the mailcow ansible role will also update an existing installation | `yes` | |
| `mailcow__config_acme_contact` | sets ACME_CONTACT in mailcow.conf | | |
| `mailcow__rspamd_clamd_servers` | configures the clamd server used by rspamd | `clamd:3310` | |
| `mailcow__rspamd_clamd_patterns` | configures custom clamd rspamd patterns inside rspamd antivirus.conf | | needs to be a list of name and regex |
| `mailcow__compose_command` | configures the command that is used for compose | `docker compose` | set to `docker-compose` for the standalone version of compose |
> [!CAUTION]
> The Variable `mailcow__redirect_http_to_https` is **deprecated** but still accepted and will be removed on a later date. Please use the replacement: `mailcow__config_http_redirect` instead.
## Usage
Minimal playbook:
```yaml
---
- name: Install Python3
hosts: all
become: true
gather_facts: false
roles:
- { role: raw,0.0, vars: {command: 'apt-get install -y python3 python3-pip'} }
- name: Main Playbook
hosts: all
become: true
gather_facts: true
vars:
mailcow__timezone: Europe/Berlin
roles:
- Ansible-Roles.docker-ce
- Ansible-Roles.docker-compose
- Ansible-Roles.mailcow
```

View file

@ -0,0 +1,119 @@
---
# -------------
# Mailcow.conf
# -------------
mailcow__config_http_port: 80
mailcow__config_http_bind:
mailcow__config_https_port: 443
mailcow__config_https_bind:
# Set this to "allow" to enable the anyone pseudo user. Disabled by default.
# When enabled, ACL can be created, that apply to "All authenticated users"
# This should probably only be activated on mail hosts, that are used exclusivly by one organisation.
# Otherwise a user might share data with too many other users.
mailcow__config_acl_anyone: disallow
# Garbage collector cleanup
# Deleted domains and mailboxes are moved to /var/vmail/_garbage/timestamp_sanitizedstring
# How long should objects remain in the garbage until they are being deleted? (value in minutes)
# Check interval is hourly
mailcow__config_maildir_gc_time: 1440
# Additional SAN for the certificate
#
# You can use wildcard records to create specific names for every domain you add to mailcow.
# Example: Add domains "example.com" and "example.net" to mailcow, change ADDITIONAL_SAN to a value like:
#ADDITIONAL_SAN=imap.*,smtp.*
# This will expand the certificate to "imap.example.com", "smtp.example.com", "imap.example.net", "imap.example.net"
# plus every domain you add in the future.
#
# You can also just add static names...
#ADDITIONAL_SAN=srv1.example.net
# ...or combine wildcard and static names:
#ADDITIONAL_SAN=imap.*,srv1.example.com
#
mailcow__config_additional_san: []
# Additional server names for mailcow UI
#
# Specify alternative addresses for the mailcow UI to respond to
# This is useful when you set mail.* as ADDITIONAL_SAN and want to make sure mail.maildomain.com will always point to the mailcow UI.
# If the server name does not match a known site, Nginx decides by best-guess and may redirect users to the wrong web root.
# You can understand this as server_name directive in Nginx.
# Comma separated list without spaces! Example: ADDITIONAL_SERVER_NAMES=a.b.c,d.e.f
mailcow__config_additional_server_names: []
# Skip running ACME (acme-mailcow, Let's Encrypt certs) - y/n
mailcow__config_skip_lets_encrypt: n
# Let's Encrypt registration contact information
# Optional: Leave empty for none
# This value is only used on first order!
# Setting it at a later point will require the following steps:
# https://mailcow.github.io/mailcow-dockerized-docs/troubleshooting/debug-reset_tls/
mailcow__config_acme_contact: ""
# Create seperate certificates for all domains - y/n
# this will allow adding more than 100 domains, but some email clients will not be able to connect with alternative hostnames
# see https://wiki.dovecot.org/SSL/SNIClientSupport
mailcow__config_enable_ssl_sni: n
# Skip IPv4 check in ACME container - y/n
mailcow__config_skip_ip_check: n
# Skip HTTP verification in ACME container - y/n
mailcow__config_skip_http_verification: n
# Skip ClamAV (clamd-mailcow) anti-virus (Rspamd will auto-detect a missing ClamAV container) - y/n
mailcow__config_skip_clamd: n
# Skip SOGo: Will disable SOGo integration and therefore webmail, DAV protocols and ActiveSync support (experimental, unsupported, not fully implemented) - y/n
mailcow__config_skip_sogo: n
# Allow admins to log into SOGo as email user (without any password)
mailcow__config_allow_admin_email_login: n
# Enable watchdog (watchdog-mailcow) to restart unhealthy containers
mailcow__config_use_watchdog: n
# Send watchdog notifications by mail (sent from watchdog@MAILCOW_HOSTNAME)
# CAUTION:
# 1. You should use external recipients
# 2. Mails are sent unsigned (no DKIM)
# 3. If you use DMARC, create a separate DMARC policy ("v=DMARC1; p=none;" in _dmarc.MAILCOW_HOSTNAME)
# Multiple rcpts allowed, NO quotation marks, NO spaces
mailcow__config_watchdog_notify_email:
# Notify about banned IP (includes whois lookup)
mailcow__config_watchdog_notify_ban: y
# Subject for watchdog mails. Defaults to "Watchdog ALERT" followed by the error message.
mailcow__config_watchdog_subject:
# Checks if mailcow is an open relay. Requires a SAL. More checks will follow.
# https://www.servercow.de/mailcow?lang=en
# https://www.servercow.de/mailcow?lang=de
# No data is collected. Opt-in and anonymous.
# Will only work with unmodified mailcow setups.
mailcow__config_watchdog_external_checks: n
# Max log lines per service to keep in Redis logs
mailcow__config_log_lines: 9999
# SOGo session timeout in minutes
mailcow__config_sogo_expire_session: 480
# Dovecot Indexing (FTS) Process maximum heap size in MB, there is no recommendation, please see Dovecot docs.
# Flatcurve is used as FTS Engine. It is supposed to be pretty efficient in CPU and RAM consumption.
# Please always monitor your Resource consumption!
mailcow__config_fts_heap: 128
# Controls how many processes the Dovecot indexing process can spawn at max.
# Too many indexing processes can use a lot of CPU and Disk I/O
# Please visit: https://doc.dovecot.org/configuration_manual/service_configuration/#indexer-worker for more informations
mailcow__config_fts_procs: 1
# Skip FTS (Fulltext Search) for Dovecot on low-memory, low-threaded systems or if you simply want to disable it.
# Dovecot inside mailcow use Flatcurve as FTS Backend.
mailcow__config_skip_fts: n
# Redirect HTTP connections to HTTPS - y/n
mailcow__config_http_redirect: n

View file

@ -0,0 +1,25 @@
---
mailcow__hostname: "{{ inventory_hostname }}"
mailcow__install_path: "/opt/mailcow-dockerized"
mailcow__git_repo: 'https://github.com/mailcow/mailcow-dockerized.git'
mailcow__git_version: master
mailcow__timezone: Europe/Berlin
mailcow__docker_compose_project_name: mailcowdockerized
# Change theme (default: lumen)
# Needs to be one of those: cerulean, cosmo, cyborg, darkly, flatly, journal, lumen, paper, readable, sandstone,
# simplex, slate, spacelab, superhero, united, yeti
# See https://bootswatch.com/
# WARNING: Only lumen is loaded locally. Enabling any other theme, will download external sources.
mailcow__theme: lumen
mailcow__install_updates: yes
mailcow__rspamd_clamd_servers: clamd:3310
# Change this to "docker-compose" if you use the standalone version of compose
mailcow__compose_command: docker compose

View file

@ -0,0 +1,23 @@
---
- name: Restart mailcow
become: yes
shell: |
{{ mailcow__compose_command }} --project-name {{ mailcow__docker_compose_project_name }} restart
args:
chdir: "{{ mailcow__install_path }}"
- name: Recreate mailcow
become: yes
shell: |
{{ mailcow__compose_command }} --project-name {{ mailcow__docker_compose_project_name }} down
{{ mailcow__compose_command }} --project-name {{ mailcow__docker_compose_project_name }} up -d
args:
chdir: "{{ mailcow__install_path }}"
- name: Restart mailcow rspamd
become: yes
shell: |
{{ mailcow__compose_command }} --project-name {{ mailcow__docker_compose_project_name }} restart rspamd-mailcow
args:
chdir: "{{ mailcow__install_path }}"

View file

@ -0,0 +1,21 @@
---
galaxy_info:
author: The mailcow maintainers
description: Setup mailcow dockerized using ansible
role_name: mailcow
namespace: mailcow
min_ansible_version: 2.11
license: GNU General Public License 3
platforms:
- name: Ubuntu
versions:
- xenial
- bionic
- focal
galaxy_tags:
- mailcow
- mailserver
- docker
dependencies:
- role: docker-ce
- role: docker-compose

View file

@ -0,0 +1,88 @@
---
- name: "Uncomment mailcow.conf lines"
become: yes
replace:
path: "{{ mailcow__install_path }}/mailcow.conf"
regexp: "^#({{ item }}=)$"
replace: '\1'
notify: Recreate mailcow
loop:
- WATCHDOG_NOTIFY_EMAIL
- WATCHDOG_SUBJECT
- ACME_CONTACT
- name: Warn if mailcow__redirect_http_to_https is used
debug:
msg: "WARNING: The variable 'mailcow__redirect_http_to_https' is depcrecated and will be removed soon. Please use 'mailcow__config_http_redirect' instead."
when: mailcow__redirect_http_to_https is defined
- name: "Set deprecated variable mailcow__redirect_http_to_https to mailcow__config_http_redirect"
set_fact:
mailcow__config_http_redirect: "{{ 'y' if mailcow__redirect_http_to_https | default(false) else 'n' }}"
when: mailcow__redirect_http_to_https is defined
- name: "Configure mailcow.conf"
become: yes
replace:
path: "{{ mailcow__install_path }}/mailcow.conf"
regexp: "^{{ item.variable }}=.*"
replace: "{{ item.variable }}={{ item.value }}"
notify: Recreate mailcow
loop:
- variable: HTTP_PORT
value: "{{ mailcow__config_http_port }}"
- variable: HTTP_BIND
value: "{{ (mailcow__config_http_bind | ansible.utils.ipaddr) if mailcow__config_http_bind is not none else '' }}"
- variable: HTTPS_PORT
value: "{{ mailcow__config_https_port }}"
- variable: HTTPS_BIND
value: "{{ (mailcow__config_https_bind | ansible.utils.ipaddr) if mailcow__config_https_bind is not none else '' }}"
- variable: ACL_ANYONE
value: "{{ mailcow__config_acl_anyone }}"
- variable: MAILDIR_GC_TIME
value: "{{ mailcow__config_maildir_gc_time }}"
- variable: ADDITIONAL_SAN
value: "{{ mailcow__config_additional_san | join(',') }}"
- variable: ADDITIONAL_SERVER_NAMES
value: "{{ mailcow__config_additional_server_names | join(',') }}"
- variable: SKIP_LETS_ENCRYPT
value: "{{ mailcow__config_skip_lets_encrypt }}"
- variable: ENABLE_SSL_SNI
value: "{{ mailcow__config_enable_ssl_sni }}"
- variable: SKIP_IP_CHECK
value: "{{ mailcow__config_skip_ip_check }}"
- variable: SKIP_HTTP_VERIFICATION
value: "{{ mailcow__config_skip_http_verification }}"
- variable: SKIP_CLAMD
value: "{{ mailcow__config_skip_clamd }}"
- variable: SKIP_SOGO
value: "{{ mailcow__config_skip_sogo }}"
- variable: ALLOW_ADMIN_EMAIL_LOGIN
value: "{{ mailcow__config_allow_admin_email_login }}"
- variable: USE_WATCHDOG
value: "{{ mailcow__config_use_watchdog }}"
- variable: WATCHDOG_NOTIFY_EMAIL
value: "{{ mailcow__config_watchdog_notify_email }}"
- variable: WATCHDOG_NOTIFY_BAN
value: "{{ mailcow__config_watchdog_notify_ban }}"
- variable: WATCHDOG_SUBJECT
value: "{{ mailcow__config_watchdog_subject }}"
- variable: WATCHDOG_EXTERNAL_CHECKS
value: "{{ mailcow__config_watchdog_external_checks }}"
- variable: LOG_LINES
value: "{{ mailcow__config_log_lines }}"
- variable: SOGO_EXPIRE_SESSION
value: "{{ mailcow__config_sogo_expire_session }}"
- variable: COMPOSE_PROJECT_NAME
value: "{{ mailcow__docker_compose_project_name }}"
- variable: ACME_CONTACT
value: "{{ mailcow__config_acme_contact }}"
- variable: FTS_HEAP
value: "{{ mailcow__config_fts_heap }}"
- variable: FTS_PROCS
value: "{{ mailcow__config_fts_procs }}"
- variable: SKIP_FTS
value: "{{ mailcow__config_skip_fts }}"
- variable: HTTP_REDIRECT
value: "{{ mailcow__config_http_redirect }}"

View file

@ -0,0 +1,73 @@
---
- name: Install required apt packages
become: yes
apt:
name: git
state: present
- name: Check if mailcow installation directory exists
become: yes
stat:
path: "{{ mailcow__install_path }}"
register: mailcow_installed
- name: Clone mailcow git repo
become: yes
git:
repo: "{{ mailcow__git_repo }}"
version: "{{ mailcow__git_version }}"
umask: '022'
update: false
dest: "{{ mailcow__install_path }}"
when: not mailcow_installed.stat.exists
- name: Generate mailcow.conf file
shell: |
umask 0022
./generate_config.sh
environment:
MAILCOW_HOSTNAME: "{{ mailcow__hostname }}"
MAILCOW_TZ: "{{ mailcow__timezone }}"
MAILCOW_BRANCH: "{{ mailcow__git_version }}"
args:
executable: /bin/bash
chdir: "{{ mailcow__install_path }}"
creates: mailcow.conf
tags:
- skip_ansible_lint
- name: Template settings for mailcow.conf
import_tasks: mailcowconf.yml
- name: Configure Rspamd
import_tasks: rspamd.yml
- name: Migrate NGINX Redirect
import_tasks: nginx.yml
- name: Copy vars.local.inc.php
become: yes
template:
src: vars.local.inc.php.j2
dest: "{{ mailcow__install_path }}/data/web/inc/vars.local.inc.php"
- name: Check if mailcow containers are running
become: yes
community.docker.docker_container_info:
name: "{{ mailcow__docker_compose_project_name }}-nginx-mailcow-1"
register: mailcow_running
- name: Start mailcow container stack
become: yes
shell: |
{{ mailcow__compose_command }} --project-name {{ mailcow__docker_compose_project_name }} up -d
args:
chdir: "{{ mailcow__install_path }}"
when: not mailcow_running.exists
- name: Update mailcow
include_tasks: update.yml
when:
- mailcow_running.exists
- mailcow__install_updates

View file

@ -0,0 +1,7 @@
---
- name: Delete redirect.conf due to implementation of HTTP_REDIRECT variable
become: yes
file:
path: "{{ mailcow__install_path }}/data/conf/nginx/redirect.conf"
state: absent
when: mailcow__config_http_redirect

View file

@ -0,0 +1,11 @@
---
- name: Deploy rspamd antivirus.conf
become: yes
template:
src: antivirus.conf.j2
dest: "{{ mailcow__install_path }}/data/conf/rspamd/local.d/antivirus.conf"
owner: root
group: root
mode: "0644"
notify: Restart mailcow rspamd

View file

@ -0,0 +1,36 @@
---
- name: Copy updater script
become: yes
template:
src: updater.sh.j2
dest: /opt/mailcowupdater.sh
mode: '0777'
- name: Create update logs directory
become: yes
file:
dest: /var/log/mailcow-update/
state: directory
- name: Update mailcow
become: yes
shell: /opt/mailcowupdater.sh
args:
executable: /bin/bash
register: mailcow_update
changed_when: 'not "No updates are available" in mailcow_update.stdout'
tags:
- skip_ansible_lint
- name: Show mailcow update log
debug:
var: mailcow_update.stdout_lines
- name: Write update log to file
become: yes
copy:
content: "{{ mailcow_update.stdout }}"
dest: "/var/log/mailcow-update/update-{{ ansible_date_time.iso8601_basic_short }}.log"
no_log: True
when: 'not "No updates are available" in mailcow_update.stdout'

View file

@ -0,0 +1,20 @@
# DEPLOYED BY MAILCOW ANSIBLE ROLE
clamav {
# Scan whole message
scan_mime_parts = false;
#scan_text_mime = true;
#scan_image_mime = true;
symbol = "CLAM_VIRUS";
type = "clamav";
log_clean = true;
servers = "{{ mailcow__rspamd_clamd_servers | default('clamd:3310') }}";
max_size = 20971520;
{% if mailcow__rspamd_clamd_patterns is defined and mailcow__rspamd_clamd_patterns | length > 0 %}
patterns {
{% for pattern in mailcow__rspamd_clamd_patterns %}
{{ pattern.name }} = "{{ pattern.regex }}";
{% endfor %}
}
{% endif %}
}

View file

@ -0,0 +1,14 @@
server {
root /web;
listen 80 default_server;
listen [::]:80 default_server;
include /etc/nginx/conf.d/server_name.active;
if ( $request_uri ~* "%0A|%0D" ) { return 403; }
location ^~ /.well-known/acme-challenge/ {
allow all;
default_type "text/plain";
}
location / {
return 301 https://$host$uri$is_args$args;
}
}

View file

@ -0,0 +1,21 @@
#!/usr/bin/env bash
# Update Mailcow
# Author: ntimo
cd {{ mailcow__install_path }} || exit
echo "Updating updater before runnning update"
git fetch origin master
git checkout origin/master update.sh
if ./update.sh -c | grep -q 'Updated code is available'; then
echo "Upgrading Mailcow"
echo "Installing updates"
printf "%s\n" "y" "y" | ./update.sh
echo "Collecting Gargabe"
echo 'y' | ./update.sh --gc
else
echo "No updates are available"
fi

View file

@ -0,0 +1,4 @@
<?php
// Set the default theme to be paper
$DEFAULT_THEME = '{{ mailcow__theme }}';