d2c9ed3e45
The playbook can now optimize itself based on the enabled components in for all hosts in the inventory (`just optimize`) or for a specific host (`just optimize-for-host HOSTNAME`). The optimized playbook will have: - fewer requirements (fewer roles need to be installed by `just roles`) - a shorter and quicker to evaluate `group_vars/mash_servers` file - a `setup.yml` file which includes less roles Running the playbook optimized is still work in progress. There still probably exist various role dependencies in the group-vars file, etc. The `optimize-reset` command aims to restore your playbook to a non-optimized state, which should work as before (and not experience bugs). The playbook takes care to notice of changes to the various files in `templates/` (`setup.yml`, `requirements.yml`, `group_vars_mash_servers`) and update your optimized or non-optimized copies that are derived from these templates. To do this, it keeps `.srchash` files in the `run/` directory. When it notices a change in the source file's hash (by comparing to the `.srchash` file), it will update you to the new template. Optimization state is stored in a file in `run/` as well (`optimization-vars-files.state`). Should the playbook notice changes in the source `template/` files, it should update you and re-optimize using the same parameters as before (read from the state file). |
||
|---|---|---|
| .github | ||
| bin | ||
| docs | ||
| examples | ||
| group_vars | ||
| roles/mash/playbook_base | ||
| run | ||
| templates | ||
| .editorconfig | ||
| .gitignore | ||
| ansible.cfg | ||
| CHANGELOG.md | ||
| justfile | ||
| LICENSE | ||
| README.md | ||
| releases.opml | ||
Mother-of-All-Self-Hosting Ansible playbook
MASH (Mother-of-All-Self-Hosting) is an Ansible playbook that helps you self-host services as Docker containers on your own server.
By running services in containers, we can have a predictable and up-to-date setup, across multiple supported distros and CPU architectures.
This project allows self-hosting of a large number of services and will continue to grow by adding support for FOSS.
Installation (upgrades) and some maintenance tasks are automated using Ansible (see our Ansible guide).
Supported services
See the full list of supported services here.
Installation
To configure and install services on your own server, follow the README in the docs/ directory.
Changes
This playbook evolves over time, sometimes with backward-incompatible changes.
When updating the playbook, refer to the changelog to catch up with what's new.
Support
-
Matrix room: #mash-playbook:devture.com. To join Matrix, use a public server like
matrix.orgor self-host Matrix yourself using the related matrix-docker-ansible-deploy Ansible playbook -
GitHub issues: mother-of-all-self-hosting/mash-playbook/issues
Why create such a mega playbook?
We used to maintain separate playbooks for various services (Matrix, Nextcloud, Gitea, Gitlab, Vaultwarden, PeerTube, ..). They re-used Ansible roles (for Postgres, Traefik, etc.), but were still hard to maintain due to the large duplication of effort.
Most of these playbooks hosted services which require a Postgres database, a Traefik reverse-proxy, a backup solution, etc. All of them needed to come with documentation, etc. All these things need to be created and kept up-to-date in each and every playbook.
Having to use a dedicated Ansible playbook for each and every piece of software means that you have to juggle many playbooks and make sure they don't conflict with one another when installing services on the same server. All these related playbooks interoperated nicely, but still required at least a bit of manual configuration to achieve this interoperability.
Using specialized Ansible playbooks also means that trying out new software is difficult. Despite the playbooks being similar (which eases the learning curve), each one is still a new git repository you need to clone and maintain, etc.
Furthermore, not all pieces of software are large enough to justify having their own dedicated Ansible playbook. They have no home, so no one uses them.
We're finding the need for a playbook which combines all of this into one, so that:
- you don't need to juggle multiple Ansible playbooks
- you can try out various services easily - a few lines of extra configuration and you're ready to go
- small pieces of software (like Miniflux, powered by the miniflux Ansible role) which don't have their own playbook can finally find a home
- you can use a single playbook with the quality you know and trust
- shared services (like Postgres) are maintained in one single place
- backups are made easy, because everything lives together (same base data path, same Postgres instance)
Having one large playbook with all services does not necessarily mean you need to host everything on the same server though. Feel free to use as many servers as you see fit. While containers provide some level of isolation, it's still better to not put all your eggs in one basket and create a single point of failure.
All of the aforementioned playbooks have been absorbed into this one. See the full list of supported services here. The Matrix playbook will remain separate, because it contains a huge number of components and will likely grow even more. It deserves to stand on its own.
What's with the name?
Our goal is to create a large Ansible playbook which can be your all-in-one-toolkit for self-hosting services in a clean and reliable way.
We like the MASH acronym, and mashing is popular in the alcohol brewing industry. The result of all that mash is an enjoyable (at least by some) product.
Then, there's mixing and mashing stuff, which is also what this Ansible playbook is all about - you can mix and mash various pieces of software to create the self-hosted stack of your dreams!