chore: update docs bb7ccf27
Steve Simkins · 2026-05-21 19:37 6 file(s) · +20 −5
docs/docs/pages/apps/cellar.mdx +1 −1
67 67
cd apps/cellar && go build .
68 68
```
69 69
70 -
The resulting binary at `./target/release/cellar` is self-contained with all assets embedded. Copy it to your server with a configured `.env` file and run it directly.
70 +
The resulting binary at `./cellar` is self-contained with all assets embedded. Copy it to your server with a configured `.env` file and run it directly.
71 71
72 72
## Use
73 73
docs/docs/pages/apps/feeds.mdx +6 −0
94 94
?urls=https://bearblog.dev/discover/feed/,https://bearblog.stevedylan.dev/feed/
95 95
```
96 96
97 +
Pointing `?url=` at an OPML file fetches and previews every feed it lists, up to 5 items per feed:
98 +
99 +
```
100 +
?url=https://example.com/subscriptions.opml
101 +
```
102 +
97 103
Preview mode bypasses the database and renders whatever the feed returns live.
98 104
99 105
### Feeds Export
docs/docs/pages/apps/library.mdx +1 −1
61 61
cd apps/library && go build .
62 62
```
63 63
64 -
The resulting binary at `./target/release/library` is self-contained with all assets embedded. Copy it to your server with a configured `.env` file and run it directly.
64 +
The resulting binary at `./library` is self-contained with all assets embedded. Copy it to your server with a configured `.env` file and run it directly.
65 65
66 66
## Use
67 67
docs/docs/pages/apps/posts.mdx +8 −1
22 22
|---|---|---|
23 23
| `POSTS_PASSWORD` | Password for admin login | `changeme` |
24 24
| `POSTS_DB_PATH` | SQLite database file path | `posts.sqlite` |
25 -
| `UPLOADS_DIR` | Directory for uploaded files | `uploads` |
25 +
| `UPLOADS_DIR` | Directory for uploaded files (used when R2 unset) | `uploads` |
26 26
| `SITE_URL` | Public URL for RSS feed and links | `http://localhost:3000` |
27 27
| `HOST` | Server bind address | `127.0.0.1` |
28 28
| `PORT` | Server port | `3000` |
29 29
| `COOKIE_SECURE` | Enable HTTPS-only cookies | `false` |
30 +
| `R2_BUCKET` | Cloudflare R2 bucket name (enables R2 storage) | _(unset)_ |
31 +
| `R2_ACCOUNT_ID` | Cloudflare account ID | _(unset)_ |
32 +
| `R2_ACCESS_KEY_ID` | R2 access key ID | _(unset)_ |
33 +
| `R2_SECRET_ACCESS_KEY` | R2 secret access key | _(unset)_ |
34 +
| `R2_PUBLIC_URL` | Public URL prefix for uploaded files | _(unset)_ |
35 +
36 +
Upload storage falls back to local filesystem (`UPLOADS_DIR`) when `R2_BUCKET` is empty. Set all five `R2_*` variables to switch uploads to Cloudflare R2.
30 37
31 38
## Deploy
32 39
docs/docs/pages/apps/shrink.mdx +2 −0
56 56
## Use
57 57
58 58
Upload an image, set your desired quality (1-100) and an optional target width, then download the compressed JPEG. Aspect ratio is preserved when resizing.
59 +
60 +
JPEG EXIF metadata is preserved after recompression, with GPS data stripped. Upload limit is 20 MB.
docs/docs/pages/apps/sipp.mdx +2 −2
23 23
brew install stevedylandev/tap/sipp-so
24 24
```
25 25
26 -
### Cargo
26 +
### Build from source
27 27
28 28
```bash
29 -
# Build sipp CLI from source: cd apps/sipp && go build .
29 +
cd apps/sipp && go build .
30 30
```
31 31
32 32
### Releases