1 Commits
Author SHA1 Message Date
Ferrule release 078ce1a589 Ferrule 0.0.2 2026-10-17 20:57:12 +00:00
3 changed files with 5 additions and 16 deletions

No files matched your search

+2 -9
View File
@@ -696,20 +696,13 @@ profile so neither starts unless asked:
COMPOSE_PROFILES=gotify,igotify # or just igotify, beside an existing Gotify COMPOSE_PROFILES=gotify,igotify # or just igotify, beside an existing Gotify
GOTIFY_ADMIN_USER=admin # the default GOTIFY_ADMIN_USER=admin # the default
GOTIFY_ADMIN_PASSWORD=<choose one> # unset, Gotify's admin password is "admin" GOTIFY_ADMIN_PASSWORD=<choose one> # unset, Gotify's admin password is "admin"
GOTIFY_ALERTS_PASSWORD=<choose one> # the shared account everyone signs in as
GOTIFY_URL=http://gotify GOTIFY_URL=http://gotify
GOTIFY_PORT=8091 # host ports, for a tunnel or proxy to use GOTIFY_PORT=8091 # host ports, for a tunnel or proxy to use
IGOTIFY_PORT=8092 IGOTIFY_PORT=8092
``` ```
The setup wizard writes all of this for you. With `GOTIFY_ALERTS_PASSWORD` Deploy once, open Gotify, create an application, put its token in
and no `GOTIFY_TOKEN`, Ferrule makes a Gotify account, `ferrule-alerts`, and `GOTIFY_TOKEN`, and update the stack. iGotify relays to the iPhone app
its own app in it, the first time it sends. Everyone who should get alerts
signs in to the Gotify app (or iGotify) as `ferrule-alerts`, and the admin
account stays private. In Gotify an app belongs to one user and only that
user's phones see it, which is why alerts go to a shared account. For a
team, ntfy or Pushover groups suit better. To use your own app instead,
create one in Gotify and set `GOTIFY_TOKEN`. iGotify relays to the iPhone app
through Apple's push service; the phone has to reach Gotify and iGotify, so through Apple's push service; the phone has to reach Gotify and iGotify, so
away from home put them behind a tunnel or reverse proxy. `IGOTIFY_GOTIFY_URLS`, away from home put them behind a tunnel or reverse proxy. `IGOTIFY_GOTIFY_URLS`,
`IGOTIFY_CLIENT_TOKENS` and `IGOTIFY_SECNTFY_TOKENS` are only needed when `IGOTIFY_CLIENT_TOKENS` and `IGOTIFY_SECNTFY_TOKENS` are only needed when
+2 -6
View File
@@ -23,7 +23,7 @@ services:
# version nobody chose, and never latest. FERRULE_IMAGE is the registry # version nobody chose, and never latest. FERRULE_IMAGE is the registry
# path, one line to change when it moves. Its own container names keep # path, one line to change when it moves. Its own container names keep
# it apart from an earlier stack of this project on the same host. # it apart from an earlier stack of this project on the same host.
image: ${FERRULE_IMAGE:-git.uglyhousesneedlove.com/steve/ferrule}:${FERRULE_VERSION:-dev} image: ${FERRULE_IMAGE:-ghcr.io/ferrulehq/ferrule}:${FERRULE_VERSION:?set FERRULE_VERSION to the release to run, such as 0.9.0}
# Ask the registry on every deploy. A fixed release costs one quick # Ask the registry on every deploy. A fixed release costs one quick
# request; qa moves, and this is how a redeploy picks it up. # request; qa moves, and this is how a redeploy picks it up.
pull_policy: always pull_policy: always
@@ -135,10 +135,6 @@ services:
# force; see PORTAINER.md for what each variable means. # force; see PORTAINER.md for what each variable means.
GOTIFY_URL: ${GOTIFY_URL:-} GOTIFY_URL: ${GOTIFY_URL:-}
GOTIFY_TOKEN: ${GOTIFY_TOKEN:-} GOTIFY_TOKEN: ${GOTIFY_TOKEN:-}
# With the bundled Gotify and no token, Ferrule makes a shared
# ferrule-alerts account and its own app, using the admin password.
GOTIFY_ALERTS_PASSWORD: ${GOTIFY_ALERTS_PASSWORD:-}
GOTIFY_ADMIN_PASSWORD: ${GOTIFY_ADMIN_PASSWORD:-}
NTFY_URL: ${NTFY_URL:-} NTFY_URL: ${NTFY_URL:-}
NTFY_TOKEN: ${NTFY_TOKEN:-} NTFY_TOKEN: ${NTFY_TOKEN:-}
PUSHOVER_TOKEN: ${PUSHOVER_TOKEN:-} PUSHOVER_TOKEN: ${PUSHOVER_TOKEN:-}
@@ -234,7 +230,7 @@ services:
# Stack environment can start from what is set. Never a secret. # Stack environment can start from what is set. Never a secret.
COMPOSE_PROFILES: ${COMPOSE_PROFILES:-} COMPOSE_PROFILES: ${COMPOSE_PROFILES:-}
WEB_PORT: ${WEB_PORT:-8090} WEB_PORT: ${WEB_PORT:-8090}
FERRULE_IMAGE: ${FERRULE_IMAGE:-git.uglyhousesneedlove.com/steve/ferrule} FERRULE_IMAGE: ${FERRULE_IMAGE:-ghcr.io/ferrulehq/ferrule}
FERRULE_VERSION: ${FERRULE_VERSION:-} FERRULE_VERSION: ${FERRULE_VERSION:-}
RETENTION: ${RETENTION:-13w} RETENTION: ${RETENTION:-13w}
GOTIFY_ADMIN_USER: ${GOTIFY_ADMIN_USER:-admin} GOTIFY_ADMIN_USER: ${GOTIFY_ADMIN_USER:-admin}
+1 -1
View File
@@ -2,7 +2,7 @@
# variable, this file's and the rest, from what the stack is running with. # variable, this file's and the rest, from what the stack is running with.
# Required: the release to run, such as 0.9.0, or qa for the build under test. # Required: the release to run, such as 0.9.0, or qa for the build under test.
FERRULE_VERSION=dev FERRULE_VERSION=0.0.2
# false watches only hypervisors and storage, with no UniFi console at all, # false watches only hypervisors and storage, with no UniFi console at all,
# and is what to set while trying this stack beside an existing one. # and is what to set while trying this stack beside an existing one.