Ferrule 0.0.2

This commit is contained in:
Ferrule release committed 2026-10-17 20:57:12 +00:00
1 parent f5df34769a
commit 078ce1a589
4 files changed
+11 -11

No files matched your search

+6 -6
View File
@@ -11,7 +11,7 @@ with a webhook.
on your Docker host. Portainer reads only the compose file from the
repository.
- Portainer must reach
`https://git.uglyhousesneedlove.com/steve/ferrule-deploy`. It is public,
`https://github.com/ferrulehq/ferrule-deploy`. It is public,
so no account or token is needed.
- The Docker host needs outbound internet to pull the Ferrule and
VictoriaMetrics images. A licensed install also fetches
@@ -50,9 +50,9 @@ console.
## Step 2 — The image
The image is public: Portainer pulls it with no registry login. It holds
the built binary only, never the source. Before launch it is published at
`git.uglyhousesneedlove.com/steve/ferrule`; at launch it moves to Docker Hub,
and `FERRULE_IMAGE` is the one line that changes.
the built binary only, never the source. It is published on GitHub's
container registry, `ghcr.io/ferrulehq/ferrule`. If it ever moves,
`FERRULE_IMAGE` is the one line that changes.
---
@@ -65,7 +65,7 @@ and `FERRULE_IMAGE` is the one line that changes.
3. Choose **Repository** as the build method.
4. Fill in:
- **Repository URL** —
`https://git.uglyhousesneedlove.com/steve/ferrule-deploy`
`https://github.com/ferrulehq/ferrule-deploy`
- **Repository reference** — `refs/heads/main`
- **Compose path** — `docker-compose.yml`
- **Authentication** — off; the repository is public. Turn it on only
@@ -116,7 +116,7 @@ Add these only if you need them:
| Name | Default | When to change it |
|---|---|---|
| `FERRULE_VERSION` | **required** | the release to run, such as `0.9.0`; `qa` for what is under test. Never `latest` |
| `FERRULE_IMAGE` | `git.uglyhousesneedlove.com/steve/ferrule` | where the image is published; change it only if told to |
| `FERRULE_IMAGE` | `ghcr.io/ferrulehq/ferrule` | where the image is published; change it only if told to |
| `WEB_PORT` | `8090` | something else already has 8090 |
| `UNIFI_ENABLED` | `true` | `false` to watch only hypervisors and storage, or to try this stack beside an existing one without polling the controller twice |
| `SOURCE_1` … `SOURCE_8` | empty | a hypervisor or storage system per slot, see below |
+2 -2
View File
@@ -31,12 +31,12 @@ so nothing is built on your host.
[Connect your gear](https://docs.ferrulehq.dev/connect/unifi-network/).
2. **Get the stack:**
- **Portainer:** Stacks → Add stack → name `ferrule` → **Repository**,
with URL `https://git.uglyhousesneedlove.com/steve/ferrule-deploy`,
with URL `https://github.com/ferrulehq/ferrule-deploy`,
reference `refs/heads/main`, compose path `docker-compose.yml`, and
authentication **off**.
- **Docker Compose:**
```sh
git clone https://git.uglyhousesneedlove.com/steve/ferrule-deploy.git ferrule
git clone https://github.com/ferrulehq/ferrule-deploy.git ferrule
cd ferrule
cp stack.env.example .env
```
+2 -2
View File
@@ -23,7 +23,7 @@ services:
# version nobody chose, and never latest. FERRULE_IMAGE is the registry
# 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.
image: ${FERRULE_IMAGE:-git.uglyhousesneedlove.com/steve/ferrule}:${FERRULE_VERSION:?set FERRULE_VERSION to the release to run, such as 0.9.0}
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
# request; qa moves, and this is how a redeploy picks it up.
pull_policy: always
@@ -230,7 +230,7 @@ services:
# Stack environment can start from what is set. Never a secret.
COMPOSE_PROFILES: ${COMPOSE_PROFILES:-}
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:-}
RETENTION: ${RETENTION:-13w}
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.
# Required: the release to run, such as 0.9.0, or qa for the build under test.
FERRULE_VERSION=0.0.1
FERRULE_VERSION=0.0.2
# 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.