Skip to content

Commit 5c08e6c

Browse files
committed
Update READMEs to reflect changes
1 parent 60888c6 commit 5c08e6c

4 files changed

Lines changed: 18 additions & 27 deletions

File tree

server/installer/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ This directory contains the Docker Compose deployment used to run the full telem
66

77
- `docker-compose.yml` – Orchestrates all runtime containers.
88
- `.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.
1210

1311
## Prerequisites
1412

@@ -30,7 +28,7 @@ This directory contains the Docker Compose deployment used to run the full telem
3028
3. Verify the services:
3129
```bash
3230
docker compose ps
33-
docker compose logs postgresdb3 | tail
31+
docker compose logs timescaledb | tail
3432
```
3533
4. Tear the stack down when you are finished:
3634
```bash
@@ -68,16 +66,18 @@ All secrets and tokens are defined in `.env`. The defaults provided in `.env.exa
6866

6967
| Service | Ports | Description |
7068
| --- | --- | --- |
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). |
7470
| `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. |
7874
| `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. |
8077
| `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. |
8181

8282
## Data and DBC files
8383

@@ -90,7 +90,7 @@ All secrets and tokens are defined in `.env`. The defaults provided in `.env.exa
9090

9191
## Troubleshooting tips
9292

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.
9494
- **Re-import sample data** – Run `docker compose down -v` and restart the stack to re-trigger the data loader.
9595
- **Slack services are optional** – Leave Slack variables empty or set `ENABLE_SLACK=false` to skip starting the bot during development.
9696
- **AI code generation not working** – Ensure `COHERE_API_KEY` is set in `.env`. Check logs with `docker compose logs code-generator`.

server/installer/grafana/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,12 @@ Provisioned from `provisioning/datasources/postgres.yml`:
1414

1515
| Setting | Value |
1616
| --- | --- |
17-
| URL | `${POSTGRES_DSN:-http://timescaledb:8181}` |
18-
| Organisation | `WFR` |
19-
| Bucket | `WFR25` |
20-
| Token | `${POSTGRES_PASSWORD}` (injected from `.env`) |
21-
| Query language | Flux |
17+
| Type | PostgreSQL |
18+
| URL | `timescaledb:5432` |
19+
| Database | `wfr` |
20+
| User | `$POSTGRES_USER` (from `.env`) |
21+
| Password | `$POSTGRES_PASSWORD` (from `.env`) |
22+
| TimescaleDB | enabled |
2223

2324
The datasource is marked as the default, so new panels automatically target it.
2425

universal-telemetry-software/README.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -130,13 +130,6 @@ Once `can0` is confirmed working, proceed to deployment.
130130
- CAN HAT set up (see Hardware Setup above)
131131
- Network connection between car and base (LAN cable or Ubiquiti radios)
132132

133-
> ```
134-
>
135-
> Then use the rpi5 override whenever starting the stack:
136-
> ```bash
137-
> docker compose -f deploy/docker-compose.yml up -d
138-
> ```
139-
140133
### Installation
141134

142135
Clone the repository:
@@ -354,7 +347,6 @@ universal-telemetry-software/
354347
│ ├── docker-compose.test.yml # Integration test stack (CI)
355348
│ ├── docker-compose.can-test.yml # vCAN pipeline tests
356349
│ ├── docker-compose.jitsi.yml # Optional Jitsi comms addon
357-
│ ├── docker-compose.rpi5.yml # RPi5 QEMU override
358350
│ └── WHICH_ONE.md # Compose file reference
359351
├── Dockerfile
360352
└── requirements.txt

universal-telemetry-software/deploy/offline/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ docker save \
1212
timescale/timescaledb:latest-pg16 \
1313
redis:8.2 \
1414
bluenviron/mediamtx:latest \
15-
deploy-cloud-sync:latest \
1615
grafana/grafana:latest \
1716
-o offline/wfr-docker-images.tar
1817
```
@@ -35,4 +34,3 @@ Then access at:
3534
- Pecan: http://localhost:3000
3635
- Grafana: http://localhost:8087 (admin / admin)
3736
- Status: http://localhost:8080
38-
- Cloud Sync: http://localhost:8092

0 commit comments

Comments
 (0)