readeckobo/docs/CONFIG.md

Configuration Reference

Configuration options for config.yaml. For a starting file, see config.yaml.example or the quick start.

Top-Level Options

Key	Description	Type	Default	Required
server.port	The TCP port the server listens on.	Integer	8080	No
log_level	Output verbosity. Options: debug, info, warn, error.	String	info	No
readeck.host	The full base URL of your Readeck instance.	URL String	-	Yes
users	A list of Kobo-to-Readeck user mappings.	List of Objects	-	Yes
public_url	Public origin used for the rewritten Instapaper URL in Kobo initialization.	URL String	Request host/forwarding headers	No

Set public_url when your ingress cannot reliably supply the public HTTPS origin, cannot overwrite client-supplied forwarding headers, or you need one canonical hostname. Use the origin only (no path, query, or credentials). Otherwise, Go-proxied initialization uses X-Forwarded-Host (or the request Host) and X-Forwarded-Proto (or the connection scheme), not readeck.host. Keep the app behind a trusted ingress when relying on those headers. See Cloudflare Tunnel and Nginx.

User Object

Each entry in the users list maps a Kobo device identity to a Readeck account.

Key	Description
token	A unique UUID used to identify the Kobo device. This is the Plain Text token generated by the bin/generate-encrypted-token.sh script.
readeck_access_token	The API token for the Readeck account you want to sync.
book_sync_url	Optional per-user Kobo API endpoint for an ebook service such as Komga. When used through /booksync/<device-token>/, it must generate cover and download URLs the Kobo can reach directly; readeckobo does not rewrite them. See Kobo ebook sync.
remove_archived_from_kobo	Optional, default false. In incremental sync, send archived items with status "2" (requesting removal) instead of "1". Full sync excludes them; neither setting deletes Readeck data. Verify on a real Kobo.

How to get a Readeck API Token

1. Log in to your Readeck instance.
2. Navigate to Profile > API Tokens (URL: [your-readeck-url]/profile/tokens).
3. Create a new token with at least Bookmarks: Read permissions (Write permissions are needed for archiving/favoriting).
4. Copy the token string into your config.yaml.

For Kobo-compatible ebook services, see Kobo ebook sync.