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 8080, 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
   • --remove-orphans to remove orphaned containers

cd docker docker compose up -d --remove-orphans 

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 afd3e434e853 signoz/signoz-otel-collector:0.111.24 "/signoz-collector -…" 47 minutes ago Up 45 minutes 0.0.0.0:4317-4318->4317-4318/tcp signoz-otel-collector c0b6e58d3d18 signoz/signoz:0.69.0 "./query-service --c…" 47 minutes ago Up 46 minutes (healthy) 8080/tcp signoz-signoz 69431900f6ef clickhouse/clickhouse-server:24.1.2-alpine "/entrypoint.sh" 47 minutes ago Up 47 minutes (healthy) 8123/tcp, 9000/tcp, 9009/tcp signoz-clickhouse 8b69f876a3c7 signoz/zookeeper:3.7.1 "/opt/bitnami/script…" 47 minutes ago Up 47 minutes (healthy) 2181/tcp, 2888/tcp, 3888/tcp, 8080/tcp signoz-zookeeper-1 

2. Wait for all the pods to be in running state, and then point your browser to http://<IP-ADDRESS>:8080/ 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:8080/.
• 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:8080/

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 

Next Steps

• Collect Telemetry from your Docker Clusters
• Instrument Your Application
• Tutorials