Configuration

General configuration variables control the core behavior of the Keep server. These settings determine fundamental aspects such as the server’s host, port, and whether certain components like the scheduler and consumer are enabled.

Logging and environment configuration determines how Keep generates and formats log output. These settings are crucial for debugging, monitoring, and understanding the behavior of your Keep instance in different environments.

Database configuration is crucial for Keep’s data persistence. Keep supports various database backends through SQLAlchemy, allowing flexibility in choosing and configuring your preferred database system.

Resource provisioning settings control how Keep sets up initial resources. This configuration is particularly important for automating the setup process and ensuring that necessary resources are available when Keep starts.

Authentication configuration determines how Keep verifies user identities and manages access control. These settings are essential for securing your Keep instance and integrating with various authentication providers.

Secrets Management configuration specifies how Keep handles sensitive information. This is crucial for securely storing and accessing confidential data such as API keys and integrations credentials.

OpenTelemetry configuration enables comprehensive observability for Keep. These settings allow you to integrate Keep with various monitoring and tracing systems, enhancing your ability to debug and optimize performance.

WebSocket server configuration controls real-time communication capabilities in Keep. These settings are important for enabling features that require instant updates and notifications.

OpenAPI configuration is used for integrating with OpenAI services. These settings are important if you’re utilizing OpenAI capabilities within Keep for tasks such as natural language processing or AI-assisted operations.

Posthog configuration controls Keep’s integration with the Posthog analytics platform. These settings are useful for tracking usage patterns and gathering insights about how your Keep instance is being used.

Ngrok configuration enables secure tunneling to your Keep instance. These settings are particularly useful for development or when you need to expose your local Keep instance to the internet securely.

Elasticsearch configuration controls Keep’s integration with Elasticsearch for advanced search capabilities. These settings are important if you’re using Elasticsearch to enhance Keep’s search functionality and performance.

Redis configuration specifies the connection details for Keep’s Redis instance. Redis is used for various caching and queueing purposes, making these settings important for optimizing Keep’s performance and scalability.

ARQ (Asynchronous Task Queue) configuration controls Keep’s background task processing. These settings are crucial for managing how Keep handles long-running or scheduled tasks, ensuring efficient resource utilization and responsiveness.

Frontend configuration variables control the behavior and features of Keep’s user interface. These settings are crucial for customizing the frontend’s appearance, functionality, and integration with the backend services.

Authentication configuration determines how Keep verifies user identities and manages access control. These settings are essential for securing your Keep instance and integrating with various authentication providers.

Pusher configuration is essential for enabling real-time updates and communication in Keep’s frontend. These settings allow the frontend to establish a WebSocket connection with the Pusher server, facilitating instant updates and notifications.