In the case of installing the Traceo instance on your own device, the most convenient way is to use docker compose. However, other installation methods are also supported:
After successfully instalation you can log in to your account with this credentials:
username: admin
password: admin
Remember to change your password immediately for security reasons.
Docker-compose installation instructions can be found here.
The easiest possible way to install using docker compose is to use the following one-liner:
$ curl -L https://raw.githubusercontent.com/traceo-dev/traceo/develop/docker-compose.yml -o docker-compose.yml && docker compose up
After invoking this command, the docker-compose.yml file will be downloaded and run on your machine.
You can do this also manually by:
- Install git (in case you don't have it).
- Clone this repository:
git clone https://github.com/traceo-dev/traceo.git
- Go to the folder containing the source code:
cd traceo
- Run this command to up docker-compose:
docker compose up
The first boot may take several minutes.
Traceo uses pm2 to run the application and worker. In case you need to view the logs, you can do it like this:
- Run this command from the root of the repository:
docker compose ps -q traceo
- Copy returned SHA and paste to below command and:
docker exec -it [your-sha] sh
- At this point, you have access to the container with the application. Run the following command to preview the application properties in the pm2 view:
pm2 monit
See the pm2 documentation here.
After all, Traceo should be accessible in http://localhost:3000.
If you want to use the docker image to install Traceo, you must first prepare several platforms necessary for the proper operation of the application.
- Download your own PostgreSQL database.
- Download your own Clickhouse database.
- Download your own Kafka message broker instance.
After completing all these steps, we can move on.
- Create
.env.docker
file with provided envs:
PG_HOST=[your-postgres-host]
PG_PORT=5432
PG_DB_NAME=traceo
PG_PASS=postgres
PG_USER=postgres
KAFKA_CLIENT_ID=traceo-kafka
KAFKA_HOSTS=[your-kafka-host]
KAFKA_GROUP_ID=traceo-kafka-group
CLICKHOUSE_USER=default
CLICKHOUSE_HOST=[your-clickhouse-host]
CLICKHOUSE_PASSWORD=
-
Set values for
PG_HOST
,KAFKA_HOSTS
andCLICKHOUSE_HOST
depending on your own installed instances. You can also replace other envs if you need it. -
Run this command to build docker image:
docker run \
-d -p 3000:3000 \
--env-file .env.docker \
--name=traceo \
traceo/traceo
If you don't want to use the envs file, you can also specify them in the run command as below:
docker run \
-d -p 3000:3000 \
-e PG_HOST=[env] \
-e PG_PORT=5432 \
-e PG_DB_NAME=traceo \
-e PG_PASS=postgres \
-e PG_USER=postgres \
-e KAFKA_CLIENT_ID=[env] \
-e KAFKA_HOSTS=[env] \
-e KAFKA_GROUP_ID=[env] \
-e CLICKHOUSE_USER=default \
-e CLICKHOUSE_HOST=[env] \
--name=traceo \
traceo/traceo
TIP: You can provide multiple hosts to KAFKA_HOSTS
env by separate them with comma, eq. KAFKA_HOSTS=kafka:29092,kafka:9092
.
After all, Traceo should be accessible in http://localhost:3000. To using other port you can change ports mapping in above commands.
Under implementation. come back later!