Minor docs reorganization

This commit is contained in:
Slavi Pantaleev 2023-03-17 11:43:00 +02:00
parent b98b53064f
commit fc8549201d
5 changed files with 5 additions and 11 deletions

View file

@ -4,17 +4,17 @@
By running services in containers, we can have a predictable and up-to-date setup, across multiple supported distros and CPU architectures. By running services in containers, we can have a predictable and up-to-date setup, across multiple supported distros and CPU architectures.
This project is fairly new and only supports a few [services](docs/services/README.md) so far, but will grow to support self-hosting a large number of [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) pieces of software. This project is fairly new and only [supports a handful of services](docs/supported-services.md) so far, but will grow to support self-hosting a large number of [FOSS](https://en.wikipedia.org/wiki/Free_and_open-source_software) pieces of software.
## Supported services ## Supported services
See the [full list of supported services here](docs/services/README.md). See the [full list of supported services here](docs/supported-services.md).
## Installation ## Installation
To configure and install service on your own server, follow the [README in the docs/ directory](docs/README.md). To configure and install services on your own server, follow the [README in the docs/ directory](docs/README.md).
## Changes ## Changes
@ -35,16 +35,10 @@ When updating the playbook, refer to [the changelog](CHANGELOG.md) to catch up w
You may also be interested in these other Ansible playbooks: You may also be interested in these other Ansible playbooks:
- [gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) - for deploying a [Gitea](https://gitea.io/) git version-control server - this playbook will soon be merged into `mash-playbook`
- [nextcloud-docker-ansible-deploy](https://github.com/spantaleev/nextcloud-docker-ansible-deploy) - for deploying a [Nextcloud](https://nextcloud.com/) server - this playbook will soon be merged into `mash-playbook`
- [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) - for deploying a fully-featured [Matrix](https://matrix.org) homeserver - [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) - for deploying a fully-featured [Matrix](https://matrix.org) homeserver
- [peertube-docker-ansible-deploy](https://github.com/spantaleev/peertube-docker-ansible-deploy) - for deploying a [PeerTube](https://joinpeertube.org/) video-platform server - this playbook will soon be merged into `mash-playbook` - [peertube-docker-ansible-deploy](https://github.com/spantaleev/peertube-docker-ansible-deploy) - for deploying a [PeerTube](https://joinpeertube.org/) video-platform server - this playbook will soon be merged into `mash-playbook`
- [vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy) - for deploying a [Vaultwarden](https://github.com/dani-garcia/vaultwarden) password manager server (unofficial [Bitwarden](https://bitwarden.com/) compatible server) - this playbook will soon be merged into `mash-playbook`
The [Matrix](https://matrix.org) playbook ([matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy)) will remain independent, because the Matrix ecosystem is incredibly large - lots of bots, bridges and other pieces of software. It deserves its own dedicated playbook. The [Matrix](https://matrix.org) playbook ([matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy)) will remain independent, because the Matrix ecosystem is incredibly large - lots of bots, bridges and other pieces of software. It deserves its own dedicated playbook.
All other playbooks are for smaller pieces and will be moved into into this playbook for ease of maintenance and all [reasons explained below](#why-create-such-a-mega-playbook). All other playbooks are for smaller pieces and will be moved into into this playbook for ease of maintenance and all [reasons explained below](#why-create-such-a-mega-playbook).

View file

@ -11,7 +11,7 @@ You can then follow these steps inside the playbook directory:
2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/<your-domain>/vars.yml`) 2. copy the sample configuration file (`cp examples/vars.yml inventory/host_vars/<your-domain>/vars.yml`)
3. edit the configuration file (`inventory/host_vars/<your-domain>/vars.yml`) to your liking. You should [enable one or more services](services/README.md) in your `vars.yml` file. You may also take a look at the various `roles/**/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file. 3. edit the configuration file (`inventory/host_vars/<your-domain>/vars.yml`) to your liking. You should [enable one or more services](supported-services.md) in your `vars.yml` file. You may also take a look at the various `roles/**/ROLE_NAME_HERE/defaults/main.yml` files and see if there's something you'd like to copy over and override in your `vars.yml` configuration file.
4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`) 4. copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)

View file

@ -165,4 +165,4 @@ uptime_kuma_hostname: uptime-kuma.example.com
# You can add additional services here, as you see fit. # You can add additional services here, as you see fit.
# To discover new services and configuration, see docs/services/README.md # To discover new services and configuration, see docs/supported-services.md