You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: server/installer/README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,7 @@ This directory contains the Docker Compose deployment used to run the full telem
6
6
7
7
-`docker-compose.yml` – Orchestrates all runtime containers.
8
8
-`.env.example` – Template for environment variables required by the stack.
9
-
-`postgresdb3-admin-token.json` – Development token consumed by the TimescaleDB server on first start.
10
-
-`postgresdb3-explorer-config/` – Configuration for the optional TimescaleDB web explorer container.
11
-
- Service folders (for example `file-uploader/`, `startup-data-loader/`, `slackbot/`) – Each contains the Docker context and service-specific source code.
9
+
- Service folders (for example `file-uploader/`, `slackbot/`, `sandbox/`) – Each contains the Docker context and service-specific source code.
12
10
13
11
## Prerequisites
14
12
@@ -30,7 +28,7 @@ This directory contains the Docker Compose deployment used to run the full telem
30
28
3. Verify the services:
31
29
```bash
32
30
docker compose ps
33
-
docker compose logs postgresdb3| tail
31
+
docker compose logs timescaledb| tail
34
32
```
35
33
4. Tear the stack down when you are finished:
36
34
```bash
@@ -68,16 +66,18 @@ All secrets and tokens are defined in `.env`. The defaults provided in `.env.exa
68
66
69
67
| Service | Ports | Description |
70
68
| --- | --- | --- |
71
-
|`postgresdb3`|`9000` (mapped to `8181` internally) | Core time-series database. Initialised with the admin token from `.env`. |
72
-
|`postgresdb3-explorer`|`8888`| Lightweight UI for browsing data in TimescaleDB. |
73
-
|`data-downloader`|`3000`| Periodically downloads CAN CSV archives from the DAQ server. Visual SQL query builder included. |
69
+
|`timescaledb`|`5432`| Core time-series database (TimescaleDB on PostgreSQL). |
74
70
|`grafana`|`8087`| Visualises telemetry with pre-provisioned dashboards. |
75
-
|`slackbot`|n/a|Socket-mode Slack bot for notifications and automation (optional). Integrates with code-generator for AI queries. |
76
-
|`lap-detector`|`8050`|Dash-based lap analysis web application. |
77
-
|`startup-data-loader`| n/a |Seeds TimescaleDB with sample CAN frames on first boot. |
71
+
|`data-downloader-api`|`8000`|FastAPI backend for telemetry queries with visual SQL query builder. |
72
+
|`data-downloader-frontend`|`3000`|Vite frontend for the data downloader. |
73
+
|`data-downloader-scanner`| n/a |Background scanner that indexes available data. |
78
74
|`file-uploader`|`8084`| Web UI for uploading CAN CSV archives and streaming them into TimescaleDB. |
79
-
|`sandbox`| n/a | Custom Python execution environment with internet access for running AI-generated code and TimescaleDB queries. |
75
+
|`slackbot`| n/a | Socket-mode Slack bot for notifications and automation (optional). Integrates with code-generator for AI queries. |
76
+
|`sandbox`| n/a | Custom Python execution environment for running AI-generated code and TimescaleDB queries. |
80
77
|`code-generator`|`3030` (internal) | AI-powered code generation service using Cohere. Generates Python code from natural language. |
78
+
|`health-monitor`| n/a | Monitors container health and scanner status. |
79
+
|`lap-detector`|`8050`| Dash-based lap analysis web application (shelved). |
80
+
|`startup-data-loader`| n/a | Seeds TimescaleDB with sample CAN frames on first boot. |
81
81
82
82
## Data and DBC files
83
83
@@ -90,7 +90,7 @@ All secrets and tokens are defined in `.env`. The defaults provided in `.env.exa
90
90
91
91
## Troubleshooting tips
92
92
93
-
-**Service fails to connect to TimescaleDB** – Confirm the token in `.env` matches `postgresdb3-admin-token.json`. Regenerate the volumes with `docker compose down -v` if you rotate credentials.
93
+
-**Service fails to connect to TimescaleDB** – Confirm `POSTGRES_DSN`, `POSTGRES_USER`, and `POSTGRES_PASSWORD` in `.env` are correct. Regenerate the volumes with `docker compose down -v` if you rotate credentials.
94
94
-**Re-import sample data** – Run `docker compose down -v` and restart the stack to re-trigger the data loader.
95
95
-**Slack services are optional** – Leave Slack variables empty or set `ENABLE_SLACK=false` to skip starting the bot during development.
96
96
-**AI code generation not working** – Ensure `COHERE_API_KEY` is set in `.env`. Check logs with `docker compose logs code-generator`.
0 commit comments