---
# System prepended metadata

title: ODD platform setup

---

# ODD platform setup
> The integration example of ODD platform and Clickhouse

Ensure that ports 5432 and 8080 are open

Run command from the root of repository

```docker compose -f docker/demo.yaml up -d odd-platform-enricher```

Open http://localhost:8080/management/datasources in your browser

You should be able to see the ODD datasource page.

Go to Collector section in Menegement bar ( http://localhost:8080/management/collectors). 

Add new collector. For Clickhouse create name (ex. Clickhouse), namespace - Data Lake.

Platform creates token, copy this token.

To make this collector collect your data you need to register this collector as a data source. To do this you need to register this collector in collector repository. Go to odd-collector repository.

Open `collector_config.yml` file, add config, and paste token in `token` section.

Example of configuration for Clickhouse:

```
platform_host_url: http://localhost:8080
default_pulling_interval: 1
token: "paste here token that you already copied"
plugins:
  - type: clickhouse
    name: Clickhouse
    description: "" # Optional string
    host: localhost
    port: 8123
    database: my_database
    user: username
    password: password
    secure: False
    verify: True
    query_limit: 0 # Optional string, default 0
```

**NOTE**: If you are running from docker container make sure that ports are visiable outside of container

**NOTE** Make sure that you fill the correct username and password for Clickhouse.

To start the collector in dev environment you need to activate working environment with `poetry`

**NOTE** Make sure that you installed `poetry` in your local machine

Run following commands:
`poetry install`
`poetry shell`

Your dev environment is activated.

Run command `./start.sh` from the root of repository to start odd-collector.

Now go to  http://localhost:8080/management/datasources. You should be able to see your data source Clickhouse.

Now when you create any objects in your database that you filled in the collector config (in this example - `my_database`) the platform will show these changes.