Skip to main content
Chartbrew needs a web client, a Node.js API, a MySQL or PostgreSQL database, and Redis for background jobs. Choose a deployment method below. For local development, use Quickstart.

Docker

Run Chartbrew and its supporting services with Docker Compose.

From source

Build the client and manage the API on your own server.

Hosting providers

Use a provider template or follow the setup notes for your host.

Domains and HTTPS

Connect your client and API to public HTTPS addresses.

​
Prepare your installation

  • Choose a release from Chartbrew releases. Use a fixed release tag for repeatable deployments.
  • Use a dedicated application database. The databases you query for charts are separate from this database.
  • Keep database and Redis access private. Only the client and API need public HTTPS addresses.
  • Store the encryption key and other secrets outside version control. Keep the encryption key when you update or move Chartbrew.
  • Keep persistent storage for the database and server/uploads. Back up both, together with your configuration.
  • Configure SMTP if you need invitation and password-reset emails.
The API must stay running for scheduled jobs. A host that stops idle services can interrupt scheduled updates and reports.

​
Check your deployment

  1. Open the client through its public URL and create your account.
  2. Test a connection and refresh a chart.
  3. Open a public report and an embedded chart.
  4. Generate a chart image and confirm that a scheduled update completes.
  5. Restart the application and confirm that your account, charts, and uploaded files remain available.

​
Update an existing installation

Back up the database, uploads, and configuration before an upgrade. Production startup applies pending database migrations. Start one API instance first and check the logs before you start more instances. For a v5 installation, follow Migrate from v5 to v6.