mirror of
https://github.com/ipnet-mesh/meshcore-hub.git
synced 2026-07-04 00:41:50 +02:00
Louis King
973bf23fe8
Move scattered configuration tables and operational sections out of the README into dedicated reference documents: - docs/configuration.md: single source of truth for all environment variables, grouped into 12 sections (Common, Database, Caching, Collector, Webhooks, Auth, Data Retention, API, Web Dashboard, Feature Flags, Traefik, Prometheus & Alertmanager) - docs/deployment.md: production setup, reverse proxy, multi-instance, API scaling, Redis caching - docs/observer.md: remote observers plus PACKETCAPTURE_* and SERIAL_PORT reference - docs/maintenance.md: backup and restore README is reduced from 712 to 385 lines; the ARM32/Raspberry Pi note is dropped. database.md, auth.md, webhooks.md, and content.md have their env-var tables removed and link back to configuration.md. Stale cross-references in database.md, upgrading.md, and .env.example are updated to point at the new locations.
110 lines
3.5 KiB
Markdown
110 lines
3.5 KiB
Markdown
# Custom Content
|
|
|
|
The web dashboard supports custom content including markdown pages and media files. Content is served from the `CONTENT_HOME` directory (default: `./content`).
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
content/
|
|
├── pages/ # Custom markdown pages
|
|
│ └── about.md
|
|
└── media/ # Custom media files
|
|
└── images/
|
|
├── logo.svg # Full-color custom logo (default)
|
|
└── logo-invert.svg # Monochrome custom logo (darkened in light mode)
|
|
```
|
|
|
|
## Custom Logos
|
|
|
|
The web dashboard supports custom logo images placed in `media/images/`:
|
|
|
|
- `logo.svg` — full-color logo, displayed as-is in both themes (no automatic darkening)
|
|
- `logo-invert.svg` — monochrome/two-tone logo, automatically darkened in light mode for visibility
|
|
|
|
If no custom logos are provided, the default MeshCore Hub logos are used.
|
|
|
|
## Markdown Pages
|
|
|
|
Custom pages are written in Markdown with optional YAML frontmatter for metadata. Pages automatically appear in the navigation menu and sitemap.
|
|
|
|
### Setup
|
|
|
|
```bash
|
|
# Create content directory structure
|
|
mkdir -p content/pages content/media
|
|
|
|
# Create a custom page
|
|
cat > content/pages/about.md << 'EOF'
|
|
---
|
|
title: About Us
|
|
slug: about
|
|
menu_order: 10
|
|
---
|
|
|
|
# About Our Network
|
|
|
|
Welcome to our MeshCore mesh network!
|
|
|
|
## Getting Started
|
|
|
|
1. Get a compatible LoRa device
|
|
2. Flash MeshCore firmware
|
|
3. Configure your radio settings
|
|
EOF
|
|
```
|
|
|
|
### Frontmatter Fields
|
|
|
|
Pages use YAML frontmatter for metadata:
|
|
|
|
```markdown
|
|
---
|
|
title: About Us # Browser tab title and nav link (not rendered on page)
|
|
slug: about # URL path (default: filename without .md)
|
|
menu_order: 10 # Nav sort order (default: 100, lower = earlier)
|
|
---
|
|
|
|
# About Our Network
|
|
|
|
Markdown content here (include your own heading)...
|
|
```
|
|
|
|
| Field | Default | Description |
|
|
|-------|---------|-------------|
|
|
| `title` | Filename titlecased | Browser tab title and navigation link text (not rendered on page) |
|
|
| `slug` | Filename without `.md` | URL path (e.g., `about` → `/pages/about`) |
|
|
| `menu_order` | `100` | Sort order in navigation (lower = earlier) |
|
|
|
|
The markdown content is rendered as-is, so include your own `# Heading` if desired.
|
|
|
|
### Supported Markdown Features
|
|
|
|
Pages are rendered with [Python-Markdown](https://python-markdown.github.io/) with the following extensions enabled:
|
|
|
|
| Feature | Syntax | Notes |
|
|
|---------|--------|-------|
|
|
| Headings | `# H1` through `### H3` | Rendered with `.prose` styling |
|
|
| Bold / Italic | `**bold**`, `*italic*` | Standard Markdown |
|
|
| Links | `[text](url)` | Relative paths supported |
|
|
| Unordered lists | `- item` or `* item` | Nested lists supported (3 levels) |
|
|
| Ordered lists | `1. item` | Nested lists supported (3 levels) |
|
|
| Tables | Pipe-delimited (`\| Header \|`) | Auto-generated `<thead>`/`<tbody>` |
|
|
| Fenced code blocks | ` ``` ` with optional language | Syntax highlighting via `codehilite` extension |
|
|
| Inline code | `` `code` `` | Styled with monospace font |
|
|
| Blockquotes | `> quote` | Left border styling |
|
|
| Images | `` | Use absolute paths to `/media/` |
|
|
| Table of contents | `[TOC]` marker | Auto-generated from headings |
|
|
|
|
## Docker Configuration
|
|
|
|
With Docker, mount the content directory as a read-only volume. This is already configured in `docker-compose.yml`:
|
|
|
|
```yaml
|
|
volumes:
|
|
- ${CONTENT_HOME:-./content}:/content:ro
|
|
environment:
|
|
- CONTENT_HOME=/content
|
|
```
|
|
|
|
The `CONTENT_HOME` variable (default `./content`) is documented in [configuration.md → Web Dashboard](configuration.md#web-dashboard).
|