neiam
/waxx
waxx
public · Issues · Pulls · Labels · Forks · Compare · Actions success · Badges · Packages
⭐
Log in to mark this repository.
docs: write real README (overview, features, quickstart, container images)
4124002 · gmorell · 2026-06-27 15:53
Files changed
modified
README.md
+26
−0
@@ -171,6 +171,32 @@ mix ecto.drop && mix ecto.create && mix ecto.migrate
| 171 | 171 | MIX_ENV=test mix ecto.drop && MIX_ENV=test mix ecto.create && MIX_ENV=test mix ecto.migrate |
| 172 | 172 | ``` |
| 173 | 173 | |
| 174 | +## Container images | |
| 175 | + | |
| 176 | +CI publishes a multi-registry image on every push to `master`: | |
| 177 | + | |
| 178 | +- `ghcr.io/neiam/waxx` | |
| 179 | +- `docker.io/neiam/waxx` | |
| 180 | +- `quay.io/neiam/waxx` | |
| 181 | + | |
| 182 | +Tags: `latest` (default branch), `vX.Y.Z` + `X.Y` (git tags), the branch name, | |
| 183 | +and the commit SHA. | |
| 184 | + | |
| 185 | +```sh | |
| 186 | +docker pull ghcr.io/neiam/waxx:latest | |
| 187 | + | |
| 188 | +docker run --rm -p 4000:4000 \ | |
| 189 | + -e PHX_SERVER=true \ | |
| 190 | + -e SECRET_KEY_BASE="$(openssl rand -base64 48)" \ | |
| 191 | + -e PHX_HOST=localhost \ | |
| 192 | + -e POSTGRES_HOST=host.containers.internal \ | |
| 193 | + -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=waxx \ | |
| 194 | + ghcr.io/neiam/waxx:latest | |
| 195 | +``` | |
| 196 | + | |
| 197 | +Or set `DATABASE_URL=ecto://user:pass@host/db` instead of the discrete | |
| 198 | +`POSTGRES_*` variables. | |
| 199 | + | |
| 174 | 200 | ## Deployment |
| 175 | 201 | |
| 176 | 202 | The repo ships a Kubernetes deploy plan modelled on the one used for |
Parents: df94c7b