mirror of
https://github.com/ipnet-mesh/meshcore-hub.git
synced 2026-06-16 08:04:44 +02:00
Louis King
f8c2a7bb40
- Rename ChannelVisibility.PUBLIC to ChannelVisibility.COMMUNITY - Update stored value from 'public' to 'community' across model, schema, API, CLI, and frontend - Add Alembic migration to update existing database rows - Consolidate upgrade docs: merge v0.11.0, v0.12.0, v0.13.0 into single v0.11.0 section - Add i18n visibility level translation keys (en, nl) - Update section headings on channels page to use t() for i18n - Keep visibility badges lowercase per UI design
109 lines
2.9 KiB
Markdown
109 lines
2.9 KiB
Markdown
# Seed Data
|
|
|
|
The database can be seeded with node tags from YAML files in the `SEED_HOME` directory (default: `./seed`).
|
|
|
|
## Running the Seed Process
|
|
|
|
Seeding is a separate process and must be run explicitly:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f docker-compose.dev.yml --profile seed up
|
|
```
|
|
|
|
This imports data from the following files (if they exist):
|
|
|
|
- `{SEED_HOME}/node_tags.yaml` - Node tag definitions
|
|
- `{SEED_HOME}/channels.yaml` - Channel decryption keys
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
seed/ # SEED_HOME (seed data files)
|
|
├── node_tags.yaml # Node tags for import
|
|
└── channels.yaml # Channel keys for import
|
|
|
|
data/ # DATA_HOME (runtime data)
|
|
└── collector/
|
|
└── meshcore.db # SQLite database
|
|
```
|
|
|
|
Example seed files are provided in `example/seed/`.
|
|
|
|
## Node Tags
|
|
|
|
Node tags allow you to attach custom metadata to nodes (e.g., location, role, owner). Tags are stored in the database and returned with node data via the API.
|
|
|
|
### Node Tags YAML Format
|
|
|
|
Tags are keyed by public key in YAML format:
|
|
|
|
```yaml
|
|
# Each key is a 64-character hex public key
|
|
0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef:
|
|
name: Gateway Node
|
|
description: Main network gateway
|
|
lat: 37.7749
|
|
lon: -122.4194
|
|
|
|
fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210:
|
|
name: Oakland Repeater
|
|
elevation: 150
|
|
```
|
|
|
|
Tag values can be:
|
|
|
|
- **YAML primitives** (auto-detected type): strings, numbers, booleans
|
|
- **Explicit type** (when you need to force a specific type):
|
|
```yaml
|
|
altitude:
|
|
value: "150"
|
|
type: number
|
|
```
|
|
|
|
Supported types: `string`, `number`, `boolean`
|
|
|
|
## Channels
|
|
|
|
Channel keys are used to decrypt encrypted mesh messages. They are stored in the database and loaded by the collector at startup, with periodic refresh.
|
|
|
|
### Channels YAML Format
|
|
|
|
Channels support two formats:
|
|
|
|
**Shorthand** (name → hex key string):
|
|
|
|
```yaml
|
|
MyChannel: AABBCCDD11223344AABBCCDD11223344
|
|
```
|
|
|
|
**Expanded** (name → dict with options):
|
|
|
|
```yaml
|
|
MyChannel:
|
|
key: AABBCCDD11223344AABBCCDD11223344
|
|
enabled: true
|
|
```
|
|
|
|
Key rules:
|
|
- Keys must be uppercase hex, 32 characters (AES-128) or 64 characters (AES-256)
|
|
- Seeded channels always have `visibility: community` — to set member/operator/admin visibility, use the CLI or API
|
|
- The `Public` and `test` built-in keys are always loaded into the decoder regardless of database contents
|
|
- Test channel messages are only stored when a `test` channel row exists in the database with `enabled: true`
|
|
|
|
### Managing Channels via CLI
|
|
|
|
```bash
|
|
# List all channels
|
|
meshcore-hub collector channel list
|
|
|
|
# Add a channel
|
|
meshcore-hub collector channel add --name MyChannel --key AABBCCDD11223344AABBCCDD11223344
|
|
|
|
# Enable/disable a channel
|
|
meshcore-hub collector channel enable --name MyChannel
|
|
meshcore-hub collector channel disable --name MyChannel
|
|
|
|
# Remove a channel
|
|
meshcore-hub collector channel remove --name MyChannel
|
|
```
|