diff --git a/README.md b/README.md index caaeb78..66ee876 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,8 @@ The SQLite database lives in the `/data` volume inside the container. | | | |---|---| -| ![Editor](docs/palette-previews/pastel-lavender-new.png) | ![Paste view](docs/palette-previews/pastel-lavender-paste.png) | -| ![History](docs/palette-previews/midnight-history.png) | | +| ![Editor in midnight](docs/palette-previews/midnight-new.png) | ![Paste view in pastel-peach](docs/palette-previews/pastel-peach-paste.png) | +| ![History in pastel-lavender](docs/palette-previews/pastel-lavender-history.png) | ![Saved in pastel-cloud](docs/palette-previews/pastel-cloud-mine.png) | ## Configuration @@ -53,31 +53,19 @@ The SQLite database lives in the `/data` volume inside the container. | `PALETTE_MAX_ITEM` | `26214400` | Max can item size in bytes (25 MB) | | `PALETTE_ADMIN_KEY` | generated | Admin key; if unset a 32-char hex key is generated and persisted to `/admin-key` (0600) | -### Admin - -`GET /admin` serves the admin page. Enter the admin key there — it is stored in -`sessionStorage` (never a cookie) and sent as the `X-Admin-Key` header on -`GET`/`POST /admin/api/settings`. - -The admin API reads/sets: rate-limit burst, rate-limit refill per minute, max -content bytes, default expiry, custom URL reservation days, and the burn -viewer window (minutes). All admin access attempts are logged. - -```bash -./palette --reset-admin-key # regenerate the admin key and print it -``` +An `/admin` page exists for runtime settings, protected by a key set at +install (`PALETTE_ADMIN_KEY` env var) and resettable locally — see +[docs/API.md](docs/API.md) and [docs/design/](docs/design/) for details. ## API -Create a paste with one call: +Full REST API: [docs/API.md](docs/API.md). One example: ```bash -curl -X POST http://localhost:8080/api/pastes \ - -H "Content-Type: application/json" \ - -d '{"content": "print(hello)", "language": "python", "expires_in": "168h"}' +curl -X POST http://localhost:8080/api/pastes -d '{"content":"hello"}' ``` -Full API docs: [docs/API.md](docs/API.md). Design docs: [docs/design/](docs/design/) (currently: [client-side E2E encryption](docs/design/e2e-encryption.md), issue #39). +Design docs: [docs/design/](docs/design/). ## Performance Notes diff --git a/docs/palette-previews/midnight-history.png b/docs/palette-previews/midnight-history.png deleted file mode 100644 index 85f1132..0000000 Binary files a/docs/palette-previews/midnight-history.png and /dev/null differ diff --git a/docs/palette-previews/midnight-new.png b/docs/palette-previews/midnight-new.png index 45deb48..841e6d0 100644 Binary files a/docs/palette-previews/midnight-new.png and b/docs/palette-previews/midnight-new.png differ diff --git a/docs/palette-previews/midnight-paste.png b/docs/palette-previews/midnight-paste.png deleted file mode 100644 index d41946c..0000000 Binary files a/docs/palette-previews/midnight-paste.png and /dev/null differ diff --git a/docs/palette-previews/pastel-cloud-history.png b/docs/palette-previews/pastel-cloud-history.png deleted file mode 100644 index 3e9fa8b..0000000 Binary files a/docs/palette-previews/pastel-cloud-history.png and /dev/null differ diff --git a/docs/palette-previews/pastel-cloud-mine.png b/docs/palette-previews/pastel-cloud-mine.png new file mode 100644 index 0000000..8207f42 Binary files /dev/null and b/docs/palette-previews/pastel-cloud-mine.png differ diff --git a/docs/palette-previews/pastel-cloud-new.png b/docs/palette-previews/pastel-cloud-new.png deleted file mode 100644 index 41e8c6d..0000000 Binary files a/docs/palette-previews/pastel-cloud-new.png and /dev/null differ diff --git a/docs/palette-previews/pastel-cloud-paste.png b/docs/palette-previews/pastel-cloud-paste.png deleted file mode 100644 index 575a12e..0000000 Binary files a/docs/palette-previews/pastel-cloud-paste.png and /dev/null differ diff --git a/docs/palette-previews/pastel-lavender-history.png b/docs/palette-previews/pastel-lavender-history.png index ddebfa8..db1790a 100644 Binary files a/docs/palette-previews/pastel-lavender-history.png and b/docs/palette-previews/pastel-lavender-history.png differ diff --git a/docs/palette-previews/pastel-lavender-new.png b/docs/palette-previews/pastel-lavender-new.png deleted file mode 100644 index 294c1a2..0000000 Binary files a/docs/palette-previews/pastel-lavender-new.png and /dev/null differ diff --git a/docs/palette-previews/pastel-lavender-paste.png b/docs/palette-previews/pastel-lavender-paste.png deleted file mode 100644 index dc96d9e..0000000 Binary files a/docs/palette-previews/pastel-lavender-paste.png and /dev/null differ diff --git a/docs/palette-previews/pastel-peach-history.png b/docs/palette-previews/pastel-peach-history.png deleted file mode 100644 index fef8b31..0000000 Binary files a/docs/palette-previews/pastel-peach-history.png and /dev/null differ diff --git a/docs/palette-previews/pastel-peach-new.png b/docs/palette-previews/pastel-peach-new.png deleted file mode 100644 index 0896419..0000000 Binary files a/docs/palette-previews/pastel-peach-new.png and /dev/null differ diff --git a/docs/palette-previews/pastel-peach-paste.png b/docs/palette-previews/pastel-peach-paste.png index fb0c002..f674884 100644 Binary files a/docs/palette-previews/pastel-peach-paste.png and b/docs/palette-previews/pastel-peach-paste.png differ diff --git a/docs/palette-previews/smooth-history.png b/docs/palette-previews/smooth-history.png deleted file mode 100644 index 0389b63..0000000 Binary files a/docs/palette-previews/smooth-history.png and /dev/null differ diff --git a/docs/palette-previews/smooth-new.png b/docs/palette-previews/smooth-new.png deleted file mode 100644 index f84f866..0000000 Binary files a/docs/palette-previews/smooth-new.png and /dev/null differ diff --git a/docs/palette-previews/smooth-paste.png b/docs/palette-previews/smooth-paste.png deleted file mode 100644 index 526641c..0000000 Binary files a/docs/palette-previews/smooth-paste.png and /dev/null differ