The Telebugs Manual

How to get started and use Telebugs Kyrylo Silin
  • Move Welcome
    Open Welcome

    Welcome to Telebugs

    Thank you for choosing Telebugs!

    Telebugs is a refreshingly simple error tracking tool designed to help you catch and fix production errors in real-time. Whether you're building web apps, mobile apps, embedded systems, or games, Telebugs ensures you stay on top of issues before they impact your users.

    It’s fully compatible with Sentry SDKs, meaning it works seamlessly with a wide range of languages and frameworks right out of the box.

    Unlike cloud-based error tracking services, Telebugs is self-hosted — so you own your data, with no restrictions on the number of errors, projects, or team members. Track as much as you want, invite as many collaborators as you need, and maintain complete control over your infrastructure.

    This manual will walk you through setting up Telebugs and making the most of its features.

    Let’s get started on making your software more reliable than ever!

    Welcome 148 words
  • Move Installation
    Open Installation

    Installation

    Since Telebugs is self-hosted, you'll need to have a few things ready before getting started:

    1. Your own domain name (e.g., example.com or telebugs.example.com).
    2. A machine connected to the internet.
    3. Basic tech skills (familiarity with SSH and terminal commands).

    Installation steps

    The whole process takes less than 10 minutes. Here’s how to get started:

    1. Choose a server: Select a machine to host Telebugs (cloud or local). I recommend DigitalOcean (setup guide) or Hetzner (setup guide).
    2. Point your domain: Update your DNS to link your domain to your server’s IP address. Ensure it’s a direct DNS record (no proxying — Telebugs handles SSL). ![Cloudflare DNS configuration example](https://docs.telebugs.com/u/screenshot-2025-04-30-at-12-06-32-am
    Installation 381 words
  • Move Welcome to Telebugs
    Open Welcome to Telebugs

    Welcome to Telebugs

    Congratulations on installing Telebugs — your journey to seamless, self‑hosted error tracking begins now.

    On first launch, you’ll arrive at the Set up Telebugs screen. At this point, your instance is fresh out of the oven and waiting to meet its very first user.

    Telebugs' first run

    Create your first user

    You’ll begin by creating an admin account. The setup form asks for:

    • Profile picture: Optional. It will appear throughout the dashboard and be visible to your teammates.
    • Full name: Any name works.
    • Email address: Doesn’t have to match the one you used to purchase Telebugs. Use whatever email you like.
    • Password: No strict rules here. Choose a password you trust. Telebugs assumes you know what you're doing.

    Hit Create your account, and you’re in! Your Telebugs journey has officially begun.

    Fun fact

    Telebugs’ autocomplete suggests "Grace Hopper" f

    Welcome to Telebugs 216 words
  • Move Creating Your Project
    Open Creating Your Project

    Creating Your Project

    Telebugs uses Projects to organize and isolate errors from your applications. Each project typically corresponds to a specific language, framework, or subsystem. Each project is assigned a unique token at creation, which your app uses to send errors.

    Below is a recommended workflow and an overview of the project creation form.

    How to organize projects

    • By language or framework: Group errors by language or framework for clearer context (e.g., Ruby, JavaScript, PHP, Laravel, etc.). This is the standard way.
    • By subsystem: Track web requests, background jobs, or microservices separately if desired.
    • By environment: Separate projects can track errors in different environments (e.g. staging and production)
    • Custom organization: You can consolidate all errors into one project — or carve them up however you prefer. Telebugs gives you complete freedom.

    Example

    Web app (Ruby on Rails)

    • Project name: Blog or blog.example.com
    Creating Your Project 324 words
  • Move The telebugs Command
    Open The telebugs Command

    telebugs Command reference

    Install and manage your Telebugs instance.

    To run the telebugs command, connect to your server using SSH or your cloud provider’s web-based terminal.

    Usage:

    • telebugs - [command]

    Manage passwords

    • password - Manage passwords

    Manage automatic updates

    • auto-update - Manage automatic updates

    Manage application data

    • data - Manage application data

    Additional Commands:

    • help - Help about any command
    • setup - Re-run the initial setup of Telebugs
    • start - Start Telebugs
    • status - Show the current status
    • stop - Stop Telebugs
    • update - Update Telebugs to the latest version

    Flags:

    • -h--help - help for telebugs

    Use telebugs [command] --help for more information about a command.

    The telebugs Command 118 words
  • Move Appendix
    Appendix
  • Move Installing on Digital Ocean
    Open Installing on Digital Ocean

    Installing on Digital Ocean

    Using Digital Ocean to host Telebugs is a great choice. It’s affordable and easy to set up.

    After signing up for a Digital Ocean account, follow these steps. It should take about 5 minutes.

    1. In your Digital Ocean account, go to Create > Droplets and pick a plan for your server. Creating a new droplet You need at least 2GB RAM and 1 CPU. IMPORTANT: Don't use ARM64 — Tailwind doesn't work on it yet, and Telebugs relies on Tailwind. Learn more. Regular CPU with a regular SSD

    2. Set a password to connect to your server. Choosing authentication method

    3. Leave the

    Installing on Digital Ocean 292 words
  • Move Installing on Hetzner
    Open Installing on Hetzner

    Installing on Hetzner

    Hosting Writebook on Hetzner is a smart pick. It’s budget-friendly and simple to set up if you’re comfortable with some basic tech steps.

    After signing up for a Hetzner account, follow these quick steps. It should take about 5 minutes.

    1. In your Hetzner project, click + Create Server and pick a plan. Hetzner dashboard You need at least 2GB RAM and 1 CPU. IMPORTANT: Don't use ARM64 — Tailwind doesn't work on it yet, and Telebugs relies on Tailwind. Learn more CPU type selection

    2. Keep the default settings and click Create and Buy now. Your server will be ready in a few minutes.

    3. Once it’s ready, copy the Public IP address. This link

    Installing on Hetzner 263 words
  • Move Work in Progress Pages
    Open Work in Progress Pages

    Work in Progress Pages

    Work in Progress Pages
  • Move Project Settings
    Open Project Settings

    Project Settings

    Project Settings
  • Move General Settings
    Open General Settings

    General Settings

    Placeholder.

    General Settings 4 words
  • Move Project Timezone
    Open Project Timezone

    Project Timezone

    Placeholder.

    Project Timezone 4 words
  • Move Project Platform
    Open Project Platform

    Project Platform

    Placeholder.

    Project Platform 4 words
  • Move Project Token
    Open Project Token

    Project Token

    Placeholder.

    Project Token 4 words
  • Move Data Source Name (DSN)
    Open Data Source Name (DSN)

    Data Source Name (DSN)

    Placeholder.

    Data Source Name (DSN) 6 words
  • Move Access Control
    Open Access Control

    Access Control

    Placeholder.

    Access Control 4 words
  • Move Project Notifications
    Open Project Notifications

    Project Notifications

    Placeholder.

    Project Notifications 4 words
  • Move Project Danger Zone
    Open Project Danger Zone

    Project Danger Zone

    Project Danger Zone 4 words