diff --git a/README.md b/README.md index 0ce336f..0fb5110 100644 --- a/README.md +++ b/README.md @@ -13,24 +13,22 @@ I'm only one guy, I tested with | Software | Version | |---------------------|-----------| | Debian | 13 | -| Docker Engine | 29.0.4 | -| Portainer | 2.33.4 | +| Docker Engine | 29.2.1 | +| Dockhand | 1.0.18 | ## 🤔 Assumptions These compose files make a few assumptions: -1. You are only running on one host. +1. You are running dockhand. 2. You are using Nginx Proxy Manager (although most have redundant port access). -3. Volumes are stored in the project folder under "data", git ignored and backed up externally. + ## 📚 Workflow The intended workflow is as follows: -1. Copy cookbook.env to .env of your project -1. Copy the docker-compse.yml file to your project -1. Concatonate the sample.env to .env in your project -1. OPTIONAL: concatonate network.yml into your docker-compose.yml +1. Add the repository ```https://github.com/nickyeoman/docker-compose-cookbooks.git``` to your dockhand Git repositories (in settings) +1. Create the stack in dockhand You may have to use multiple containers, such as Maria or postgres for db. @@ -48,7 +46,7 @@ As we are going to rely on COMPOSE_PROJECT_NAME to create our project names, con #### Paths -I use 3 Paths strategies: +I use 3 Paths strategies, they are all considered private: 1. VOL_PATH, usually ./data is a data directory that is not in git, backed up externally. 1. CONFIG_PATH usually ./config is stored in git (text files) diff --git a/dockhand/README.md b/dockhand/README.md index 1a4e1d1..47eb309 100644 --- a/dockhand/README.md +++ b/dockhand/README.md @@ -39,4 +39,12 @@ This is how I got it working on ansible (roughly): DOCKHAND_SERVER_URL: "{{ dockhand_url }}" TOKEN: "{{ hawser_token }}" AGENT_NAME: "{{ hawser_agent_name }}" -``` \ No newline at end of file +``` + +## NTFY Notifications + +With authentication can be tricky, do it like this, where TOKEN is your token from NTFY: +``` +ntfys://TOKEN@ntfy.nickyeoman.com/dockhand +``` +ntfy:// can be used for unsecure. diff --git a/templates.json b/templates.json deleted file mode 100644 index eb58f7a..0000000 --- a/templates.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "version": "3", - "templates": [ - { - "id": 1, - "type": 3, - "title": "bookstack", - "name": "bookstack", - "note": "Auto-generated template from repository", - "categories": [ - "Auto" - ], - "platform": "linux", - "logo": "https://i.4lt.ca/cookbooks/bookstack.png", - "description": "BookStack is a self-hosted wiki platform for organizing and storing documentation in a simple, book/chapter/page structure. This Docker Compose stack allows easy deployment with persistent storage.", - "repository": { - "url": "https://github.com/nickyeoman/docker-compose-cookbooks", - "stackfile": "bookstack/docker-compose.yml" - }, - "env": [ - { - "name": "BOOKSTACK_APP_KEY", - "label": "BOOKSTACK_APP_KEY", - "default": "APP_KEY" - }, - { - "name": "BOOKSTACK_APP_TIMEZONE", - "label": "BOOKSTACK_APP_TIMEZONE", - "default": "America/Vancouver" - }, - { - "name": "BOOKSTACK_APP_URL", - "label": "BOOKSTACK_APP_URL", - "default": "http://localhost:8080" - }, - { - "name": "BOOKSTACK_DB_DATABASE", - "label": "BOOKSTACK_DB_DATABASE", - "default": "bookstack" - }, - { - "name": "BOOKSTACK_DB_HOST", - "label": "BOOKSTACK_DB_HOST", - "default": "mariadb:3306" - }, - { - "name": "BOOKSTACK_DB_PASSWORD", - "label": "BOOKSTACK_DB_PASSWORD", - "default": "dbpass" - }, - { - "name": "BOOKSTACK_DB_USERNAME", - "label": "BOOKSTACK_DB_USERNAME", - "default": "dbuser" - }, - { - "name": "BOOKSTACK_IMAGE", - "label": "BOOKSTACK_IMAGE", - "default": "solidnerd/bookstack:latest" - }, - { - "name": "BOOKSTACK_REVISION_LIMIT", - "label": "BOOKSTACK_REVISION_LIMIT", - "default": "false" - }, - { - "name": "MARIADB_IMAGE", - "label": "MARIADB_IMAGE", - "default": "mariadb:latest" - }, - { - "name": "MARIADB_MARIADB_DATABASE", - "label": "MARIADB_MARIADB_DATABASE", - "default": "bookstack" - }, - { - "name": "MARIADB_MARIADB_ROOT_PASSWORD", - "label": "MARIADB_MARIADB_ROOT_PASSWORD", - "default": "ChangeThisPassword" - }, - { - "name": "MARIADB_MARIADB_USER", - "label": "MARIADB_MARIADB_USER", - "default": "dbuser" - }, - { - "name": "MARIADB_MARIADB_PASSWORD", - "label": "MARIADB_MARIADB_PASSWORD", - "default": "AlsoChangeThisPassword" - } - ] - }, - { - "id": 2, - "type": 3, - "title": "thunderbird", - "name": "thunderbird", - "note": "Auto-generated template from repository", - "categories": [ - "Auto" - ], - "platform": "linux", - "logo": "https://i.4lt.ca/cookbooks/thunderbird.png", - "description": "Git Hub: https://github.com/jlesage/docker-thunderbird Proxy Port: 5800", - "repository": { - "url": "https://github.com/nickyeoman/docker-compose-cookbooks", - "stackfile": "thunderbird/docker-compose.yml" - }, - "env": [ - { - "name": "THUNDERBIRD_IMAGE", - "label": "THUNDERBIRD_IMAGE", - "default": "jlesage/thunderbird:latest" - }, - { - "name": "THUNDERBIRD_WEB_AUTHENTICATION", - "label": "THUNDERBIRD_WEB_AUTHENTICATION", - "default": "1" - }, - { - "name": "THUNDERBIRD_WEB_AUTHENTICATION_USERNAME", - "label": "THUNDERBIRD_WEB_AUTHENTICATION_USERNAME", - "default": "user" - }, - { - "name": "THUNDERBIRD_WEB_AUTHENTICATION_PASSWORD", - "label": "THUNDERBIRD_WEB_AUTHENTICATION_PASSWORD", - "default": "password" - }, - { - "name": "THUNDERBIRD_SECURE_CONNECTION", - "label": "THUNDERBIRD_SECURE_CONNECTION", - "default": "1" - } - ] - } - ] -} \ No newline at end of file