This role is an opinionated approach to automating the creation of docker-compose files to run the software on my home server.
Started as a fork of the docker-compose-generator, this now works differently. I just didn't find it very useful to have almost all the values and settings in the vars file and then have a role that uses a template to simply transform it into its final state. It also didn't support using different networks to segment the different stacks. So I decided to rewrite my original fork.
All connections to all containers are proxied through traefik. This allows everything to be offered using TLS with automatically generated Let's Encrypt certificates. To improve security and further isolate the containers, each stack sits on its own network. Only the container that is the entrypoint or the frontend of the software is able to talk to traefik and vice versa, all others are only able to communicate within their network.
traefik lives in the traefik network. This network also contains the error-pages container that offers generic
error pages in case some service is not available.
Nextcloud needs a database, a redis and some other containers that make Nextcloud work.
During the first start, the database must be started first so it can be initialized. Only then start the nextcloud container. Otherwise the installation somehow breaks.
% docker compose -f docker-compose-nextcloud.yml -p nextcloud up -d nc-db
[+] Running 2/2
✔ Network nextcloud-net Created 0.1s
✔ Container nc-db Started 1.0s
docker@memoryalpha ~/home-stack
% docker compose -f docker-compose-nextcloud.yml -p nextcloud up -d nc-redis
[+] Running 1/1
✔ Container nc-redis Started 1.1s
docker@memoryalpha ~/home-stack
% docker compose -f docker-compose-nextcloud.yml -p nextcloud up -d nextcloud
[+] Running 3/3
✔ Container nc-redis Healthy 0.9s
✔ Container nc-db Healthy 0.9s
✔ Container nextcloud Started| Variable | default | Description |
|---|---|---|
homestack_output_path |
"~" |
Where to put the rendered docker-compose files |
homestack_uid |
not set | The user ID used for running docker images to not run as root |
homestack_gid |
not set | The group ID used for running docker images to not run as root |
| Variable | default | Description |
|---|---|---|
homestack_traefik_version |
2.11.3 | version of the traefik docker image |
homestack_traefik_hostingde_api_key |
not set | API key to use the hosting.de API for the Let's encrypt DNS challenge |
homestack_traefik_base_domain |
example.com | base domain name, will be prefixed with traefik. for the FQDN |
homestack_traefik_base_path |
not set | where are the traefik files stored on disk |
homestack_error_pages_version |
2.27 | version of the errorpages docker image |
homestack_error_pages_theme |
matrix | the theme used by errorpages |
| Variable | default | Description |
|---|---|---|
homestack_nextcloud_active |
true |
Switch rendering of nextcloud docker-compose file on or off |
homestack_nextcloud_uid |
"1000" |
The UID used for the nextcloud container |
homestack_nextcloud_gid |
"1000" |
The GID used for the nextcloud container |
homestack_nextcloud_image_version |
nextcloud:29.0.7-apache |
version of the nextcloud docker image |
homestack_nextcloud_base_path |
not set | where are the nextcloud files stored on disk |
homestack_nextcloud_admin_user |
admin |
username of the nextcloud admin user |
homestack_nextcloud_admin_password |
5UP3r53Cr37P455W0rD |
password of the nextcloud admin user |
homestack_nextcloud_base_domain |
example.com |
base domain name, will be prefixed with nextcloud. for the FQDN |
homestack_nextcloud_smtp_host |
not set | the host used to send nextlcoud notification emails |
homestack_nextcloud_smtp_name |
not set | username to authenticate at the SMTP host |
homestack_nextcloud_smtp_password |
not set | password to authenticate at the SMTP host |
homestack_nextcloud_mysql_path |
not set | where are the nextcloud db files stored on disk |
homestack_nextcloud_mysql_password |
password |
password for the nextcloud mysql DB |
homestack_nextcloud_mysql_root_password |
5UP3r53Cr37P455W0rD |
password of the mysql root user |
| Variable | default | Description |
|---|---|---|
homestack_ha_active |
true |
Switch rendering of home automation docker-compose file on or off |
homestack_ha_base_domain |
example.com |
base domain name, will be prefixed with a name for the respective service for the FQDN |
homestack_ha_mosquitto_image_version |
2.0.20 |
version of the eclipse-mosquitto image |
homestack_ha_mosquitto_base_path |
not set | path for storing the mosquitto data on disk |
homestack_ha_mosquitto_users |
{} |
list of users to setup for mosquitto, passwords must already be encoded using mosquitto_passwd |
homestack_ha_evcc_image_version |
0.133.0 |
version of the evcc image |
homestack_ha_evcc_base_path |
not set | path for storing the evcc data on disk |
homestack_ha_evcc_installation_id |
not set | unique ID of the installation (see evcc documentation) |
homestack_ha_evcc_mqtt_user |
evcc |
user used to connect to the mqtt broker |
homestack_ha_evcc_mqtt_password |
password |
password used to connect to the mqtt broker |
homestack_ha_evcc_vw_user |
[email protected] |
email for accessing the We Connect services |
homestack_ha_evcc_vw_password |
supersafe |
password for accessing the We Connect services |
homestack_ha_evcc_vw_vin |
WVWZZZAAZJD000000 |
VIN for accessing the We Connect services |