Skip to content

About

Configuration and Documentation for Self-Hosting Aptabase

Resources

Stars

79 stars

Watchers

1 watching

Forks

Latest commit

 

History

16 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 

Repository files navigation

Aptabase Self-Hosting Guide

This guide will help you get started with self hosting Aptabase. You can alternatively use our Cloud Hosting for a zero maintenance and fully managed solution.

Prerequisites

All you need is to have a recent version of Docker as this guide uses Docker Compose.

How-to

  1. Clone this repository
git clone https://github.com/aptabase/self-hosting
  1. Create a .env file next to docker-compose.yml with a private AUTH_SECRET. This value signs the sign-in links, so it must be unique to your instance and never copied from an example:
echo "AUTH_SECRET=$(openssl rand -base64 32)" > .env

Aptabase refuses to start when AUTH_SECRET is missing, shorter than 32 characters, or equal to a publicly known example value.

  1. Modify the docker-compose.yml file to your liking, but especially the sections with comments as the default values are just dummy examples.

  2. Run the following command to start the services:

docker-compose up -d
  1. That's it! You can now access Aptabase at http://localhost:8000 🎉

Note: By default, Aptabase is not configured to send email via SMTP . You can either see the emails in the logs or add the relevant SMTP variables in the docker-compose.yml file. A list of all Environment Variables is available here.

If that's not working, please check the logs with docker-compose logs -f and make sure there are no errors.

Upgrading from an older checkout

The ClickHouse image was moved from 23.8 to 26.8.36.3 to fix CVE-2026-116366 (unauthenticated remote code execution). Existing data volumes upgrade in place on the next docker compose up -d, but once 26.8 has written data you cannot go back to 23.x, so take a backup of the events-db-data volume first.

First Login / Account

There is no default login. Once you are able to access your self-hosted instance, you need to create/register a new account. After registering, the activation link that is required to activate it will be in the container logs. Once you follow that link, your new account will be active, and you will be able to access Aptabase in its entirity.

One-Click Deployment

Deploy on RepoCloud

About

Configuration and Documentation for Self-Hosting Aptabase

Resources

Stars

79 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors