Skip to content

Services Configuration

The API component handles all external requests and manages authentication. Its configuration is divided into two main sections: general settings and Postgres database configurations.

General Configuration

These settings control core API behaviors, including authentication and auditing. The sysadmin credentials are particularly important as they provide initial system access. The JWT secret is used for secure token generation and should be a strong, randomly generated value.

Name Description Default Value Required
PTOLEMY_USER Sysadmin username True
PTOLEMY_PASS Sysadmin password True
JWT_SECRET Secret to generate JWTs. Must be base64 encoded. True
ENABLE_AUDITING Enable auditing false False
SHUTDOWN_TIMEOUT Timeout for graceful shutdown (seconds) 10 False

Postgres Configuration

Ptolemy uses Postgres as its primary datastore. These settings define how the API connects to your Postgres instance. While default values are provided for most settings, in production environments you should explicitly configure all parameters to ensure security and reliability.

Name Description Default Value Required
POSTGRES_USER Postgres username True
POSTGRES_PASSWORD Postgres password True
POSTGRES_HOST Postgres host localhost False
POSTGRES_PORT Postgres port 5432 False
POSTGRES_DATABASE Postgres database ptolemy False