Administrators and self-hosters

Configuration

In development

Plan server addresses, private settings and client connectivity.

Configuration scope

All products are In development. Configuration keys, defaults and supported options will be documented for each approved release. Use the documentation matching your installed version rather than guessing environment-variable names.

Alexandria and Stache Server are separate services. Give each its own configuration and credentials. Stache uses Alexandria's consumer API for book intelligence; your personal library belongs to Stache.

A safe configuration workflow

  1. Record the public-facing Stache address and the Alexandria address reachable by Stache Server.
  2. Keep passwords and tokens in the installation's documented secret mechanism. Do not put them in URLs, screenshots or issue reports.
  3. Check that clients can reach Stache at the configured address and that HTTPS certificates are trusted.
  4. Change one setting at a time, keeping a private record of the prior value.
  5. Restart only when the release's instructions require it, then verify the affected connection.

A reverse proxy, container host and mobile device may see different network addresses. A mobile device's localhost points to the device itself, not your server.

Verify changes

Check server startup and a small library action after changing configuration. Keep diagnostics free of secret values. For connection failures, use troubleshooting. Before storage or database configuration changes, make a recoverable backup.