lundberg/porchlight
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README with CLI commands and fix stale module name

Browse source
This commit is contained in:
Johan Lundberg 2026-02-18 11:43:56 +01:00
parent 80960d5a1f
commit dee1b1e3bc
No known key found for this signature in database
GPG key ID: A6C152738D03C7D1
1 changed files with 44 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -34,10 +34,52 @@ uv sync --no-dev
OIDC_OP_ISSUER=https://auth.example.com \ OIDC_OP_ISSUER=https://auth.example.com \
OIDC_OP_SESSION_SECRET=$(python -c "import secrets; print(secrets.token_hex(32))") \ OIDC_OP_SESSION_SECRET=$(python -c "import secrets; print(secrets.token_hex(32))") \
uv run uvicorn fastapi_oidc_op.app:create_app \ uv run uvicorn porchlight.app:create_app \
--factory --host 0.0.0.0 --port 8000 --workers 4 --factory --host 0.0.0.0 --port 8000 --workers 4
``` ```
### Bootstrap the first admin user
After starting the app for the first time, create an admin account:
```bash
OIDC_OP_ISSUER=https://auth.example.com \
uv run porchlight initial-admin admin
```
This prints a one-time registration URL. Open it in a browser to set up
credentials (password or security key) for the admin user.
### CLI commands
Porchlight includes a CLI for administrative tasks. All commands read the same
`OIDC_OP_*` environment variables as the server.
**`porchlight create-invite <username>`** -- Generate a magic link registration
URL for a new user.
```bash
uv run porchlight create-invite alice
uv run porchlight create-invite alice --ttl 3600 --note "Onboarding"
```
| Option | Description |
|---|---|
| `--ttl SECONDS` | Link expiration (default: `OIDC_OP_INVITE_TTL`, 86400s) |
| `--note TEXT` | Optional note stored with the link |
**`porchlight initial-admin <username>`** -- Bootstrap the first admin user with
a registration link.
```bash
uv run porchlight initial-admin admin
uv run porchlight initial-admin admin --group admin --group superusers
```
| Option | Description |
|---|---|
| `--group TEXT` | Groups to assign (repeatable, default: `admin`, `users`) |
### Configuration ### Configuration
All settings are read from environment variables with the `OIDC_OP_` prefix: All settings are read from environment variables with the `OIDC_OP_` prefix:
@ -70,7 +112,7 @@ uv sync
# Start the dev server with hot reload # Start the dev server with hot reload
OIDC_OP_ISSUER=http://localhost:8000 OIDC_OP_DEBUG=true \ OIDC_OP_ISSUER=http://localhost:8000 OIDC_OP_DEBUG=true \
uv run uvicorn fastapi_oidc_op.app:create_app \ uv run uvicorn porchlight.app:create_app \
--factory --host 127.0.0.1 --port 8000 --reload --reload-dir src --factory --host 127.0.0.1 --port 8000 --reload --reload-dir src
``` ```