Quickstart

1. Clone the repository

Start by cloning the Checkend Community Edition repository:

sudo git clone https://github.com/Checkend/community-edition.git /opt/checkend
sudo chown -R $USER:$USER /opt/checkend
cd /opt/checkend

2. Run setup

Run the setup script to configure your instance:

./setup.sh

3. Start Checkend

Launch Checkend with Docker Compose:

docker compose up -d --build

The first build takes a few minutes. Once complete, access your instance:

• Direct SSL mode: Visit https://your-domain.com
• Reverse proxy mode: Configure your proxy to forward to port 3000, then visit your domain

4. Create your first app

In the dashboard, create a new app to get your ingestion key. You'll use this key to send errors to Checkend.

After creating the app, you can optionally assign it to a team to collaborate with others. See the Teams documentation for more information.

5. Send a test error

Use curl to send a test error to your Checkend instance:

curl -X POST https://your-domain.com/ingest/v1/errors \
  -H "Content-Type: application/json" \
  -H "Checkend-Ingestion-Key: your-ingestion-key" \
  -d '{
    "error_class": "TestError",
    "error_message": "This is a test error",
    "backtrace": ["app/test.rb:1:in test"]
  }'