ginnoir/famapp
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: replace personal domains and ips with generic placeholders

Browse Source
This commit is contained in:
ginnoir
2026-06-02 19:33:49 -05:00
parent 4ec1f34150
commit fe4673f1cd
4 changed files with 20 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+2 -2
View File
@@ -1,5 +1,5 @@
# Public app URL (used for OIDC redirect URIs, share links, etc.) # Public app URL (used for OIDC redirect URIs, share links, etc.)
NEXT_PUBLIC_APP_URL=https://fam.ginnoir.com NEXT_PUBLIC_APP_URL=https://fam.yourdomain.com
# Postgres # Postgres
DATABASE_URL=postgres://famapp:famapp@localhost:5432/famapp DATABASE_URL=postgres://famapp:famapp@localhost:5432/famapp
@@ -15,7 +15,7 @@ DEV_LOGIN_NAME=Dev User
DEV_HOUSEHOLD_NAME=Home DEV_HOUSEHOLD_NAME=Home
# OIDC (Authentik) # OIDC (Authentik)
AUTH_OIDC_ISSUER=https://auth.ginnoir.com/application/o/famapp/ AUTH_OIDC_ISSUER=https://auth.yourdomain.com/application/o/famapp/
AUTH_OIDC_CLIENT_ID=replace-me AUTH_OIDC_CLIENT_ID=replace-me
AUTH_OIDC_CLIENT_SECRET=replace-me AUTH_OIDC_CLIENT_SECRET=replace-me
.env.production.example
+3 -4
View File
@@ -1,6 +1,5 @@
# ── famapp ──────────────────────────────────────────────────────────────────── # ── famapp ────────────────────────────────────────────────────────────────────
# These vars are consumed by the famapp service in docker-compose.yml. # These vars are consumed by the famapp service in docker-compose.yml.
# The production .env lives on valhalla at ~/htpc-download-box/.env
# Image tag to deploy. Pin to a specific version after first deploy # Image tag to deploy. Pin to a specific version after first deploy
# (e.g. ghcr.io/ginnoir/famapp:v0.1.0). `latest` is fine for staging/initial. # (e.g. ghcr.io/ginnoir/famapp:v0.1.0). `latest` is fine for staging/initial.
@@ -10,7 +9,7 @@ AUTHENTIK_IMAGE_TAG=2024.12.3
RUN_MIGRATIONS=true RUN_MIGRATIONS=true
# Public URL for the app # Public URL for the app
AUTH_URL=https://fam.ginnoir.com AUTH_URL=https://fam.yourdomain.com
# famapp Postgres # famapp Postgres
FAMAPP_DB_USER=famapp FAMAPP_DB_USER=famapp
@@ -23,7 +22,7 @@ FAMAPP_DB_NAME=famapp
AUTH_SECRET=replace-with-openssl-rand-base64-32 AUTH_SECRET=replace-with-openssl-rand-base64-32
# OIDC provider (Authentik) — fill in after bootstrapping Authentik # OIDC provider (Authentik) — fill in after bootstrapping Authentik
AUTH_OIDC_ISSUER=https://auth.ginnoir.com/application/o/famapp/ AUTH_OIDC_ISSUER=https://auth.yourdomain.com/application/o/famapp/
AUTH_OIDC_CLIENT_ID=replace-me AUTH_OIDC_CLIENT_ID=replace-me
AUTH_OIDC_CLIENT_SECRET=replace-me AUTH_OIDC_CLIENT_SECRET=replace-me
@@ -33,7 +32,7 @@ VAPID_PRIVATE_KEY=
VAPID_SUBJECT=mailto:your-email@example.com VAPID_SUBJECT=mailto:your-email@example.com
# ntfy push fallback # ntfy push fallback
NTFY_URL=https://ntfy.ginnoir.com NTFY_URL=https://ntfy.yourdomain.com
NTFY_TOPIC=famapp NTFY_TOPIC=famapp
# Log level: error | warn | info | debug # Log level: error | warn | info | debug
deploy/authentik/README.md
+7 -7
View File
@@ -6,13 +6,13 @@ Run these steps once after the first `docker compose up -d` in the `deploy/` dir
## 1. Set the admin password ## 1. Set the admin password
Visit `https://auth.ginnoir.com/if/flow/initial-setup/` and set the **akadmin** password. Visit `https://auth.yourdomain.com/if/flow/initial-setup/` and set the **akadmin** password.
--- ---
## 2. Create the OIDC provider ## 2. Create the OIDC provider
1. Log in to the Authentik Admin UI at `https://auth.ginnoir.com/if/admin/`. 1. Log in to the Authentik Admin UI at `https://auth.yourdomain.com/if/admin/`.
2. Go to **Applications → Providers → Create**. 2. Go to **Applications → Providers → Create**.
3. Choose **OAuth2/OpenID Provider**. 3. Choose **OAuth2/OpenID Provider**.
4. Configure: 4. Configure:
@@ -21,7 +21,7 @@ Visit `https://auth.ginnoir.com/if/flow/initial-setup/` and set the **akadmin**
- **Client type:** `Confidential` - **Client type:** `Confidential`
- **Client ID:** (auto-generated — copy this) - **Client ID:** (auto-generated — copy this)
- **Client Secret:** (auto-generated — copy this) - **Client Secret:** (auto-generated — copy this)
- **Redirect URIs:** `https://fam.ginnoir.com/api/auth/callback/authentik` - **Redirect URIs:** `https://fam.yourdomain.com/api/auth/callback/authentik`
- **Signing Key:** `authentik Self-signed Certificate` - **Signing Key:** `authentik Self-signed Certificate`
- **Token validity:** 24 hours (or your preference) - **Token validity:** 24 hours (or your preference)
5. Save and note the **Issuer URL** shown on the provider detail page. 5. Save and note the **Issuer URL** shown on the provider detail page.
@@ -29,13 +29,13 @@ Visit `https://auth.ginnoir.com/if/flow/initial-setup/` and set the **akadmin**
The issuer URL will look like: The issuer URL will look like:
``` ```
https://auth.ginnoir.com/application/o/famapp/ https://auth.yourdomain.com/application/o/famapp/
``` ```
Set this (and the client ID/secret) in famapp's `.env` / production secrets: Set this (and the client ID/secret) in famapp's `.env` / production secrets:
```env ```env
AUTH_OIDC_ISSUER=https://auth.ginnoir.com/application/o/famapp/ AUTH_OIDC_ISSUER=https://auth.yourdomain.com/application/o/famapp/
AUTH_OIDC_CLIENT_ID=<client-id> AUTH_OIDC_CLIENT_ID=<client-id>
AUTH_OIDC_CLIENT_SECRET=<client-secret> AUTH_OIDC_CLIENT_SECRET=<client-secret>
``` ```
@@ -49,7 +49,7 @@ AUTH_OIDC_CLIENT_SECRET=<client-secret>
- **Name:** `famapp` - **Name:** `famapp`
- **Slug:** `famapp` - **Slug:** `famapp`
- **Provider:** select the `famapp` provider created above - **Provider:** select the `famapp` provider created above
- **Launch URL:** `https://fam.ginnoir.com` - **Launch URL:** `https://fam.yourdomain.com`
3. Save. 3. Save.
--- ---
@@ -68,7 +68,7 @@ AUTH_OIDC_CLIENT_SECRET=<client-secret>
Each user can enroll a passkey from their Authentik profile: Each user can enroll a passkey from their Authentik profile:
1. Sign in as the user at `https://auth.ginnoir.com`. 1. Sign in as the user at `https://auth.yourdomain.com`.
2. Go to **Settings → MFA Devices → Add → WebAuthn Device**. 2. Go to **Settings → MFA Devices → Add → WebAuthn Device**.
3. Follow the browser prompt to register a Touch ID / Face ID / hardware key. 3. Follow the browser prompt to register a Touch ID / Face ID / hardware key.
docs/dev-login.md
+8 -8
View File
@@ -42,11 +42,11 @@ pnpm dev:local
The script prints three URLs at startup: The script prints three URLs at startup:
| URL | Use for | | URL | Use for |
| -------------------------- | ---------------------------------------------------------- | | ---------------------------- | ---------------------------------------------------------- |
| `http://localhost:3000` | Browser on this machine | | `http://localhost:3000` | Browser on this machine |
| `http://192.168.1.74:3000` | Phone on the same WiFi (general UI testing) | | `http://192.168.x.y:3000` | Phone on the same WiFi (general UI testing) |
| `https://dev.ginnoir.com` | Push notifications + PWA install (needs Caddy — see below) | | `https://dev.yourdomain.com` | Push notifications + PWA install (needs Caddy — see below) |
Then open `/login` and click **Dev login**. Then open `/login` and click **Dev login**.
@@ -74,11 +74,11 @@ Route through the existing Caddy server on the home server instead — no extra
**Step 1 — DHCP reservation** **Step 1 — DHCP reservation**
Set a reservation on the router so the dev machine always gets `192.168.1.74`. Set a reservation on the router so the dev machine always gets `192.168.x.y`.
**Step 2 — DNS record** **Step 2 — DNS record**
Add a `dev.ginnoir.com` A record pointing to the same public IP as `fam.ginnoir.com`. Add a `dev.yourdomain.com` A record pointing to the same public IP as `fam.yourdomain.com`.
**Step 3 — Windows Firewall** **Step 3 — Windows Firewall**
@@ -97,7 +97,7 @@ Paste `deploy/Caddyfile.dev.snippet` into the home server Caddyfile and reload:
caddy reload --config /path/to/Caddyfile caddy reload --config /path/to/Caddyfile
``` ```
After this, `https://dev.ginnoir.com` proxies to the dev machine with a real Let's Encrypt cert. After this, `https://dev.yourdomain.com` proxies to the dev machine with a real Let's Encrypt cert.
## Current Local E2E Procedure ## Current Local E2E Procedure