Skip to content

docs: document RSS_API_TOKEN configuration #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Skulldorom merged 2 commits into from
Jul 20, 2026
Merged

docs: document RSS_API_TOKEN configuration #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
132db51
docs: document RSS_API_TOKEN configuration
Skulldorom Jul 20, 2026
3f323db
docs: show how to generate RSS_API_TOKEN
Skulldorom Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ FRESHRSS_PASS=your-freshrss-password

# Optional bearer token — when set, all protected endpoints require
# `Authorization: Bearer <token>`. Leave blank or omit to skip auth.
RSS_API_TOKEN=replace-with-a-long-random-secret
RSS_API_TOKEN=your-long-random-api-token
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ accepts all requests — convenient for trusted/internal networks. Set
`RSS_API_TOKEN` to a long random secret to require an `Authorization: Bearer <token>`
header on every protected endpoint. `/health` always remains unauthenticated.

Generate a long random token with OpenSSL and save it in `.env`:

```bash
RSS_API_TOKEN=$(openssl rand -hex 32)
printf 'RSS_API_TOKEN=%s\n' "$RSS_API_TOKEN" >> .env
```

```bash
# With auth enabled (token set):
curl \
Expand Down Expand Up @@ -86,6 +93,15 @@ Copy the example environment file and set the required values:
cp .env.example .env
```

Configure these environment variables in `.env` or your Compose environment:

| Variable | Required | Default if unset | Description |
| --- | --- | --- | --- |
| `FRESHRSS_HOST` | Yes | No default; app startup fails. | FreshRSS base URL reachable from the API container. The example `.env` uses `http://freshrss` for a same-network Compose service. |
| `FRESHRSS_USER` | Yes | No default; app startup fails. | FreshRSS username used for Google Reader API login. |
| `FRESHRSS_PASS` | Yes | No default; app startup fails. | FreshRSS password used for Google Reader API login. |
| `RSS_API_TOKEN` | No | Empty/unset; bearer auth disabled. | Optional bearer token for this API. When set, protected endpoints require `Authorization: Bearer <token>`. |

`FRESHRSS_HOST` must be a URL that is reachable **from the API container**. Do
not use `localhost`: inside the container that name refers to the API container
itself, not FreshRSS. Compose validates `FRESHRSS_HOST`, `FRESHRSS_USER`, and
Expand All @@ -111,6 +127,8 @@ services:
FRESHRSS_HOST: http://freshrss
FRESHRSS_USER: ${FRESHRSS_USER:?Set FRESHRSS_USER in .env}
FRESHRSS_PASS: ${FRESHRSS_PASS:?Set FRESHRSS_PASS in .env}
# Optional: require Authorization: Bearer <token> on protected endpoints.
RSS_API_TOKEN: ${RSS_API_TOKEN:-}
```

Equivalently, keep the provided Compose file and set this in `.env`:
Expand Down
Loading