Installation
Self-hosted error monitoring for your applications. This guide covers everything you need to run Checkend on your own server.
Prerequisites
Before installing Checkend, make sure you have the following:
- Linux server with at least 1 GB RAM
- Git
- Docker and Docker Compose — the setup script can install these automatically on Ubuntu/Debian
1. Clone the repository
Terminal
sudo git clone https://github.com/Checkend/community-edition.git /opt/checkend
sudo chown -R $USER:$USER /opt/checkend
cd /opt/checkend2. Run setup
Terminal
./setup.shThe setup script will:
- Install Docker and Docker Compose if needed (Ubuntu/Debian)
- Configure docker group permissions
- Clone the Checkend application source
- Generate secure secrets
- Configure your deployment mode (direct SSL or reverse proxy)
3. Start Checkend
Terminal
docker compose up -d --build
The first build takes a few minutes. Building locally ensures the image is optimized for your server's architecture.
4. Create your account
Access Checkend based on your deployment mode:
- Direct SSL mode: Visit
https://your-domain.com - Reverse proxy mode: Configure your proxy to forward to port 3000, then visit your domain
Environment Variables
The following environment variables are configured by the setup script:
| Variable | Required | Description |
|---|---|---|
SECRET_KEY_BASE | Yes | 64+ character secret for encryption |
POSTGRES_PASSWORD | Yes | PostgreSQL database password |
THRUSTER_TLS_DOMAIN | No | Domain for automatic SSL certificates |
Updating
To update to the latest version:
Terminal
cd /opt/checkend
./setup.sh # Select "update" when prompted
docker compose up -d --build
To switch to a specific version, remove the checkend directory and re-run setup:
Terminal
cd /opt/checkend
rm -rf checkend
./setup.sh # Enter the version tag (e.g., v1.1.0)
docker compose up -d --buildData & Backups
All data is stored in Docker volumes:
-
storage— Uploaded files and Active Storage data -
postgres_data— PostgreSQL database
Backup database:
Terminal
cd /opt/checkend
docker compose exec db pg_dump -U checkend checkend_production > backup.sqlBackup storage:
Terminal
cd /opt/checkend
docker run --rm -v checkend_storage:/data -v $(pwd):/backup alpine tar czf /backup/storage.tar.gz -C /data .Troubleshooting
View logs:
Terminal
cd /opt/checkend
docker compose logs -f appAccess Rails console:
Terminal
cd /opt/checkend
docker compose exec app bin/rails consoleReset database:
Terminal
cd /opt/checkend
docker compose down
docker volume rm checkend_postgres_data
docker compose up -d --build