Skip to main content

Docker Standalone

SigNoz can be installed on macOS or Linux computers, and there are two ways in which you can install SigNoz:

  • You may execute a script that checks your environment, installs Docker Engine and Docker Compose on Linux, and runs the docker compose up command for you.
  • You may execute the docker compose up command yourself.

Both methods are provided below.

info

SigNoz recommends you to use the install script on macOS and the following Linux distributions:

  • Ubuntu
  • Debian
  • OpenSuse
  • CentOS
  • SUSE Linux Enterprise Server (SLES)

If you're using a different Linux distribution, see the Install SigNoz Using Docker Compose section.

Prerequisites

  • A Linux or macOS machine. Microsoft Windows is not officially supported.
  • On macOS, you must manually install Docker Engine before you run the install script. The install script automatically installs Docker Engine on Linux.
  • A minimum of 4GB of memory must be allocated to Docker.
  • Git client
  • Ensure that the ports 3301, 4317 and 4318 are open on the machine where you install SigNoz.

Install SigNoz Using the Install Script

  1. In a directory of your choosing, clone the SigNoz repository and cd into the signoz/deploy directory by entering the following commands:

    git clone -b main https://github.com/SigNoz/signoz.git && cd signoz/deploy/
  2. Run the install.sh script:

    ./install.sh

Install SigNoz Using Docker Compose

info

Before you install Signoz, ensure that Docker Compose is installed on your machine.

  1. In a directory of your choosing, clone the SigNoz repository and cd into the signoz/deploy directory by entering the following commands:

    git clone -b main https://github.com/SigNoz/signoz.git && cd signoz/deploy/
  2. To install SigNoz, enter the sudo docker-compose up command, specifying the following:

    • -f and the path to your configuration file
    • -d to run containers in the background
    sudo docker-compose -f docker/clickhouse-setup/docker-compose.yaml up -d

Verify the Installation

  1. Ensure that your containers are running correctly. To view the status of your containers, run the following command:
docker ps

The output should look similar to the following:

CONTAINER ID   IMAGE                                          COMMAND                  CREATED          STATUS                    PORTS                                                                            NAMES
1ad413fc12aa signoz/frontend:0.8.0 "nginx -g 'daemon of…" 20 minutes ago Up 20 minutes 80/tcp, 0.0.0.0:3301->3301/tcp, :::3301->3301/tcp frontend
419f7b440412 signoz/alertmanager:0.23.0-0.1 "/bin/alertmanager -…" 20 minutes ago Up 20 minutes 9093/tcp clickhouse-setup_alertmanager_1
95f5fab00c3c signoz/otelcontribcol:0.43.0-0.1 "/otelcontribcol --c…" 21 minutes ago Up 21 minutes 0.0.0.0:4317-4318->4317-4318/tcp, :::4317-4318->4317-4318/tcp, 55679-55680/tcp clickhouse-setup_otel-collector_1
c1640c215d10 signoz/otelcontribcol:0.43.0-0.1 "/otelcontribcol --c…" 21 minutes ago Up 21 minutes 4317/tcp, 55679-55680/tcp clickhouse-setup_otel-collector-metrics_1
9db88c61f7fd signoz/query-service:0.8.0 "./query-service -co…" 21 minutes ago Up 21 minutes (healthy) 8080/tcp query-service
509ab96c5393 clickhouse/clickhouse-server:22.4-alpine "/entrypoint.sh" 22 minutes ago Up 21 minutes (healthy) 8123/tcp, 9000/tcp, 9009/tcp clickhouse-setup_clickhouse_1
eb7a2e23c0c0 grubykarol/locust:1.2.3-python3.9-alpine3.12 "/docker-entrypoint.…" 22 minutes ago Up 21 minutes 5557-5558/tcp, 8089/tcp load-hotrod
f234b5cb4512 jaegertracing/example-hotrod:1.30 "/go/bin/hotrod-linu…" 22 minutes ago Up 21 minutes 8080-8083/tcp hotrod
  1. Wait for all the pods to be in running state, and then point your browser to http://<IP-ADDRESS>:3301/ to access the dashboard, replacing <IP-ADDRESS> with the IP address of the machine where you installed SigNoz.

    Example:

    • If you're running SigNoz on your local machine, you should point your browser to http://localhost:3301/.
    • If the IP address of the machine on which you're running SigNoz is 66.82.18.247, you should point your browser to http://66.82.18.247:3301/
info

The docker-compose.yaml installs a sample application named HotR.O.D that generates tracing data. You can explore the SigNoz dashboard with the data provided by the sample application. If you wish to remove the sample application, follow the steps in the Remove the Sample Application section.

Install specific version of SigNoz

  1. In a directory of your choosing, clone the SigNoz repository and cd into the signoz/deploy directory by entering the following commands:

    git clone -b main https://github.com/SigNoz/signoz.git && cd signoz/deploy/
  2. Checkout to the specific version tag. For example, to install SigNoz version v0.6.1:

    git checkout v0.6.1
  3. Run the install.sh script:

    ./install.sh

Go to Docker Standalone Operate section for detailed instructions.

Next Steps