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.

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

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 docker compose up command, specifying the following:

   • -f and the path to your configuration file
   • -d to run containers in the background

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
01f044c4686a   signoz/frontend:0.38.2                       "nginx -g 'daemon of…"   2 minutes ago   Up 9 seconds                  80/tcp, 0.0.0.0:3301->3301/tcp                                                     signoz-frontend
86aa5b875f9f   gliderlabs/logspout:v3.2.14                  "/bin/logspout syslo…"   2 minutes ago   Up 1 second                   80/tcp                                                                             signoz-logspout
58746f684630   signoz/alertmanager:0.23.4                   "/bin/alertmanager -…"   2 minutes ago   Up 9 seconds                  9093/tcp                                                                           signoz-alertmanager
2cf1ec96bdb3   signoz/query-service:0.38.2                  "./query-service -co…"   2 minutes ago   Up About a minute (healthy)   8080/tcp                                                                           signoz-query-service
e9f0aa66d884   signoz/signoz-otel-collector:0.88.11          "/signoz-collector -…"   2 minutes ago   Up 10 seconds                 0.0.0.0:4317-4318->4317-4318/tcp                                                   signoz-otel-collector
d3d89d7d4581   clickhouse/clickhouse-server:23.11.1-alpine   "/entrypoint.sh"         2 minutes ago   Up 2 minutes (healthy)        0.0.0.0:8123->8123/tcp, 0.0.0.0:9000->9000/tcp, 0.0.0.0:9181->9181/tcp, 9009/tcp   signoz-clickhouse
9db88aefb6ed   signoz/locust:1.2.3                          "/docker-entrypoint.…"   2 minutes ago   Up 2 minutes                  5557-5558/tcp, 8089/tcp                                                            load-hotrod
60bb3b77b4f7   bitnami/zookeeper:3.7.1                      "/opt/bitnami/script…"   2 minutes ago   Up 2 minutes                  0.0.0.0:2181->2181/tcp, 0.0.0.0:2888->2888/tcp, 0.0.0.0:3888->3888/tcp, 8080/tcp   signoz-zookeeper-1
98c7178b4004   jaegertracing/example-hotrod:1.30            "/go/bin/hotrod-linu…"   9 days ago      Up 2 minutes                  8080-8083/tcp                                                                      hotrod

2. 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/

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.

Related Topics

• Troubleshoot SigNoz Installation Issues

Next Steps

• Instrument Your Application
• Tutorials
• Operate SigNoz on Docker Standalone