Documentation

Telescope is a web application that provides an intuitive interface for exploring log data. It supports multiple data sources, including ClickHouse and Docker. Users can configure connections, filter and search logs, and build visualizations through a unified and user-friendly interface.

Telescope uses FlyQL as a query abstraction layer, offering a consistent and secure querying experience across different source types. While ClickHouse remains the primary backend for structured log storage, support for additional sources is continuously evolving.

Quickstart

Prerequisites

• Install Docker on your machine.

1. Download the Docker Image

Pull the latest Docker image from GitHub Container Registry:

docker pull ghcr.io/iamtelescope/telescope:latest

2. Copy the SQLite Database and config templates

Download the SQLite database template and config template from the repository and save it to a local folder. You can use wget to fetch it:

mkdir ~/.telescope/
wget -O ~/.telescope/db.sqlite3 "https://raw.githubusercontent.com/iamtelescope/telescope/refs/heads/main/dev/db.sqlite3"
wget -O ~/.telescope/config.yaml "https://raw.githubusercontent.com/iamtelescope/telescope/refs/heads/main/dev/config.yaml"

3. Start the Docker Container

Run the Docker container with the appropriate parameters:

docker run \
    -e TELESCOPE_CONFIG_FILE="/config.yaml" \
    -v $(realpath ~/.telescope/config.yaml):/config.yaml \
    -v $(realpath ~/.telescope/db.sqlite3):/db.sqlite3 \
    --network host \
    ghcr.io/iamtelescope/telescope:latest

Once started, the service will be available on localhost port 9898. Proceed to http://localhost:9898/setup to create a superuser account.