Repository navigation
Add one-command local dev stack (authentik, Gitea, Mongo, Redis, Mailpit) and update local dev docs - #105
Merged
Conversation
Adds peopleportal/dev-stack: authentik, Gitea, MongoDB, Redis, Postgres and Mailpit via Docker Compose, with idempotent bootstrap scripts, a smoke test (verify.sh), and project-scoped reset. Conventional default ports, all overridable and bound to 127.0.0.1. webui/vite.config.ts reads optional PP_DEV_* port overrides and is unchanged in behavior when they are unset. Rewrites the local development guide around the stack and keeps the manual instructions in a Manual setup section. S3 storage is a documented follow-up.
IanCou
force-pushed
the
feat/dev-stack
branch
from
October 26, 2026 19:23
50ad611 to
92850ab
Compare
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a local People Portal development stack based on the version that passed the complete from-ZIP restore, service verification and persistence test. Contributors can bootstrap Authentik, Gitea, MongoDB, Redis, Postgres and Mailpit locally, then run the portal and UI through the existing Nx wrapper.
How to try it
Requirements: Docker with Compose v2.20+, Bash, curl, OpenSSL, Python 3.9+ for the port preflight, and Node.js 22.12+ with npm for the host applications. Windows requires WSL2 with Docker integration; run the commands inside WSL2.
From a fresh clone:
Open http://localhost:5173 and sign in as akadmin with AUTHENTIK_BOOTSTRAP_PASSWORD from peopleportal/dev-stack/.env. Mail appears at http://localhost:8025. Keep the generated env output private.
If a port is busy, export its override before first setup, for example PORTAL_PORT=3100, WEBUI_PORT=5174, GITEA_PORT=3101 or REDIS_PORT=6380. For later changes, stop this project's services and the host applications, edit dev-stack/.env, clear the corresponding derived URL, and rerun setup. Existing env files are preserved, so update them from the printed output. The README lists every exact variable and explains how to remove stale UI overrides when returning to defaults.
From peopleportal/dev-stack, use ./scripts/verify.sh for service checks, docker compose stop to preserve data, and ./scripts/reset.sh for a confirmed deletion of only this project's service data. Reset changes the Gitea token on the next bootstrap; update the server env afterward.
Validation in this worktree
The Docker stack and host applications were deliberately not run in this worktree. Runtime verification of these contributor-facing port and env changes remains for the fresh-clone test. The earlier successful from-ZIP test establishes the copied base's runtime provenance, not a new runtime result for these adaptations. Browser OIDC login/logout is also outside the smoke checks.
Known gaps
Notes for reviewers
local-development.mdunder "Manual setup (without the dev stack)", with headings demoted one level.GITEA_PORT(3001) matches the pinned port of the wiki dev server (npm startincorpwiki/). The guide notes to setGITEA_PORT=3002if both run.