diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 12 insertions, 8 deletions
@@ -4,9 +4,12 @@ A small multi-tenant blog host. One Go binary + Postgres. Bloggers log in at `example.com` to manage their blog; each blog is served at `<name>.example.com`. Server-rendered HTML, no JavaScript required, works on old browsers and phones. -- Posts and page intros are written in **Markdown** (sanitized on save). Images can be - inserted straight from the editor (file picker, paste or drag-and-drop; with JavaScript - off the file is appended on save). +- Posts and page intros are written in **Markdown** (sanitized on save). Files of any + kind — images, PDFs, archives, audio… — can be inserted straight from the editor (file + picker, paste or drag-and-drop; with JavaScript off the file is appended on save): + images are shown, everything else becomes a download link. The **Files** tab lists + them by kind with search, rename and delete. Uploads are 10 MB per file by default; + the superadmin can set a different limit per blog. - **Announcements**: blog-wide notices (next meeting, this month's book, a closure) shown at the top or bottom of the main content or of a side column; each can be hidden without deleting. - Every blog has **pages** (Home, About, News, …); each page holds posts. @@ -22,7 +25,7 @@ Server-rendered HTML, no JavaScript required, works on old browsers and phones. the 404 page. What the blogger writes is never translated. - A **superadmin** creates bloggers, resets passwords, disables or deletes accounts. - The **root domain is itself a blog**, owned by the superadmin and managed like any other. -- **Each blog is its own Postgres database** (`blog_<name>`), images included, so one +- **Each blog is its own Postgres database** (`blog_<name>`), uploaded files included, so one `pg_dump` is a complete backup of a blog and one `psql` restores it. A small control database holds the users and the list of blogs. @@ -64,7 +67,7 @@ Go changes need a restart. | `DATABASE_URL` | local dev DSN | Connection string of the **control** database; blog databases are created next to it by the same role | | `JWT_SECRET` | — | **Required** outside dev; long random string (`openssl rand -hex 32`) | | `SUPERADMIN_USERNAME` / `SUPERADMIN_PASSWORD` | `admin` / — | Created on first start if no superadmin exists | -| `MAX_UPLOAD_MB` | `5` | Image upload limit | +| `MAX_UPLOAD_MB` | `10` | Per-file upload limit; the superadmin can override it per blog in `/admin/` | | `DEV` | `false` | Hot-reload templates, allow missing secrets | Migrations run automatically at startup, for the control database and for every blog database. @@ -87,7 +90,7 @@ nginx example: server { listen 443 ssl; server_name example.com *.example.com; # wildcard certificate - client_max_body_size 8m; # >= MAX_UPLOAD_MB + client_max_body_size 101m; # the Files page sends up to 10 files per request: >= 10 x the largest blog limit + 1 MB location / { proxy_pass http://127.0.0.1:8080; proxy_set_header Host $host; @@ -104,7 +107,7 @@ certificates need the DNS challenge). Every blog lives in its own database, `blog_<name>` (dashes become underscores: `my-blog` → `blog_my_blog`). The control database (`blogspace`) holds the users -and the blog registry. Images are in the blog database, so one dump is the whole blog. +and the blog registry. Uploaded files are in the blog database, so one dump is the whole blog. ```sh # one blog @@ -136,7 +139,8 @@ the release that contains the split once (it moves each blog into its own database at start-up), then clear the old migration history so later migrations apply: `docker compose exec db psql -U blogspace -c "DELETE FROM goose_db_version WHERE version_id > 1"`. Current releases no longer carry the -split code. Blog pools are small (4 connections each, closed when +split code, and the first control migration after the split (the per-blog +upload limit) is refused as "missing" until that history is cleared. Blog pools are small (4 connections each, closed when idle); with many blogs busy at once, raise `max_connections` on the `db` service. ## Layout |