Files

T

wmantly 8e78604a37 Persist Redis (AOF+vol), read config from mounted secrets.js, add backup/restore docs (#118 )

Lossless upgrades + config story for the all-in-one proxy image.

Redis persistence (Part A):
- Replace in-memory `--save "" --appendonly no` with AOF + RDB persisted to
  /data. Host records, permissions, DNS creds, local users, AND the
  lua-resty-auto-ssl Let's Encrypt certs now all survive container recreation
  (persisting Redis persists the cert store — no LE re-issue / rate-limit on
  rebuild).
- Add the `proxy-data` named volume -> /data in docker-compose.yml; fix the
  stale "in-memory, lost on recreation" comment.

Config from ./config/proxy-secrets.js (Part B):
- docker-entrypoint.sh: when /config/proxy-secrets.js is mounted, symlink it to
  /app/conf/secrets.js so @simpleworkjs/conf reads the oidc/ldap/auth config
  from the file. No app_* env should then be passed (app_* beats secrets.js).
  Falls back to app_* env when the file is absent (standalone still works).
- docker-compose.yml: drop all app_oidc__* / app_ldap__* / app_auth__* env and
  add `./config:/config:ro`. Keep RESOLVER/REAL_IP_FROM/NODE_ENV/NODE_PORT
  (OpenResty-runtime / process env, not app_* config). No env_file.
- New secrets.js.example (the proxy had none): oidc (enabled, endpoints,
  clientId/clientSecret, redirectUri, scopes, claims), ldap (url, bindDN,
  bindPassword, searchBase, userFilter, tlsOptions), auth (adminGroups,
  adminUsers, groupRoleMap), plus an orchestrator-only `stack` key.

Backup/restore docs:
- Full "Backups and restore" runbook in DEPLOYMENT.md (what lives where, manual
  backup, Redis restore with the AOF-vs-RDB note — AOF wins on startup so the
  AOF must be deleted before an RDB load; restoring Redis restores cert state
  at snapshot time; migrations note). Update the Setup + Auto-SSL sections.
- docs/docker.md: update Quick start + How configuration works + Auto-SSL for
  the new ./config/ approach (app_* env now advanced/optional).

Co-authored-by: Claude <noreply@anthropic.com>

2026-07-12 13:00:34 -04:00

_config.yml

Gitpage added

2025-12-31 16:51:27 -05:00

api.md

Gitpage added

2025-12-31 16:51:27 -05:00

architecture.md

Add model-redis package references to documentation

2025-12-31 20:35:55 -05:00

CNAME

Create CNAME

2026-02-11 11:21:00 -05:00

contributing.md

Add model-redis package references to documentation

2025-12-31 20:35:55 -05:00

dev_setup.md

docs

2019-06-30 21:58:02 -04:00

docker.md

Persist Redis (AOF+vol), read config from mounted secrets.js, add backup/restore docs (#118 )

2026-07-12 13:00:34 -04:00

index.md

Dockerize the proxy (all-in-one image) + Docker docs

2026-07-11 17:02:52 -04:00

installation.md

Gitpage added

2025-12-31 16:51:27 -05:00

README.md

Gitpage added

2025-12-31 16:51:27 -05:00

Update 4.11.md

update docs

2020-04-11 16:57:57 -04:00

README.md

Documentation

This directory contains the GitHub Pages documentation site for the Proxy project.

Live site: https://theta42.github.io/proxy/

Local Preview

To preview the site locally:

# Install Jekyll (one-time setup)
gem install jekyll bundler

# Run local server
cd docs
jekyll serve

# View at http://localhost:4000/proxy/

Theme

The site uses the Cayman theme (jekyll-theme-cayman). Configuration is in _config.yml.

Updating Documentation

Edit markdown files in this directory
Commit and push to master branch
GitHub Pages automatically rebuilds (may take 1-2 minutes)
Changes visible at https://theta42.github.io/proxy/

Legacy Documentation

dev_setup.md - Old development setup notes (kept for reference)
Update 4.11.md - Old update notes (kept for reference)