Update README and declare missing dependencies

Add JIRORIAN_BASE_URL, JIRORIAN_PORT, JIRORIAN_APP_SECRETS to env var
table, fix dev command path (src/jirorian/), and explicitly declare
coincurve and cryptography in pyproject.toml.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
randogoth 2026-06-08 10:29:16 +03:00
parent b5bcef3d0a
commit 1f57b690dd
3 changed files with 11 additions and 2 deletions

View file

@ -16,6 +16,10 @@ All configuration is via environment variables:
| Variable | Description | | Variable | Description |
|---|---| |---|---|
| `JIRORIAN_BASE_URL` | Public base URL of this service (e.g. `https://upload.example.com`) |
| `JIRORIAN_PORT` | Port to listen on (default: `8000`) |
| `JIRORIAN_DB` | SQLite DB path (default: `jirorian.db`) |
| `JIRORIAN_APP_SECRETS` | JSON object mapping app names to their shared secrets, e.g. `{"myapp": "secret123"}` |
| `R2_ENDPOINT` | `https://<account_id>.r2.cloudflarestorage.com` | | `R2_ENDPOINT` | `https://<account_id>.r2.cloudflarestorage.com` |
| `R2_ACCESS_KEY_ID` | R2 access key | | `R2_ACCESS_KEY_ID` | R2 access key |
| `R2_SECRET_ACCESS_KEY` | R2 secret key | | `R2_SECRET_ACCESS_KEY` | R2 secret key |
@ -23,13 +27,12 @@ All configuration is via environment variables:
| `R2_CDN_URL` | Public CDN base URL | | `R2_CDN_URL` | Public CDN base URL |
| `SERVICE_NOSTR_PRIVKEY` | Service Nostr private key (hex) | | `SERVICE_NOSTR_PRIVKEY` | Service Nostr private key (hex) |
| `SERVICE_RELAY_URL` | Relay to subscribe to for registrations | | `SERVICE_RELAY_URL` | Relay to subscribe to for registrations |
| `JIRORIAN_DB` | SQLite DB path (default: `jirorian.db`) |
## Development ## Development
```bash ```bash
nix develop # enter dev shell with uv + virtualenv nix develop # enter dev shell with uv + virtualenv
uv run fastapi dev jirorian/main.py uv run fastapi dev src/jirorian/main.py
``` ```
## Deployment ## Deployment

View file

@ -8,6 +8,8 @@ dependencies = [
"boto3>=1.35.0", "boto3>=1.35.0",
"pynostr>=0.6.2", "pynostr>=0.6.2",
"websockets>=13.0", "websockets>=13.0",
"coincurve>=21.0.0",
"cryptography>=44.0.0",
] ]
[project.scripts] [project.scripts]

4
uv.lock generated
View file

@ -579,6 +579,8 @@ version = "0.1.0"
source = { editable = "." } source = { editable = "." }
dependencies = [ dependencies = [
{ name = "boto3" }, { name = "boto3" },
{ name = "coincurve" },
{ name = "cryptography" },
{ name = "fastapi", extra = ["standard"] }, { name = "fastapi", extra = ["standard"] },
{ name = "pynostr" }, { name = "pynostr" },
{ name = "websockets" }, { name = "websockets" },
@ -587,6 +589,8 @@ dependencies = [
[package.metadata] [package.metadata]
requires-dist = [ requires-dist = [
{ name = "boto3", specifier = ">=1.35.0" }, { name = "boto3", specifier = ">=1.35.0" },
{ name = "coincurve", specifier = ">=21.0.0" },
{ name = "cryptography", specifier = ">=44.0.0" },
{ name = "fastapi", extras = ["standard"], specifier = ">=0.115.0" }, { name = "fastapi", extras = ["standard"], specifier = ">=0.115.0" },
{ name = "pynostr", specifier = ">=0.6.2" }, { name = "pynostr", specifier = ">=0.6.2" },
{ name = "websockets", specifier = ">=13.0" }, { name = "websockets", specifier = ">=13.0" },