Skip to content

Commit e41daa5

Browse files
author
Ivan
committed
chore: standardize formatting
1 parent 41511fc commit e41daa5

6 files changed

Lines changed: 3981 additions & 3981 deletions

File tree

‎docs/agents/overview.md‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -269,29 +269,29 @@ When identity/network is not ready, prefer **503** with a retryable message over
269269

270270
Common overrides (CLI flags usually mirror these):
271271

272-
| Variable / flag | Purpose |
273-
| ---------------------------------------------------------- | ------------------------------------------------ |
274-
| `MESHCHAT_HOST` / `--host` | Bind address (default `127.0.0.1`) |
275-
| `MESHCHAT_PORT` / `--port` | Bind port (default `8000`) |
276-
| `MESHCHAT_HEADLESS` / `--headless` | Do not auto-launch a browser |
277-
| `MESHCHAT_STORAGE_DIR` / `--storage-dir` | App storage root |
278-
| `MESHCHAT_RETICULUM_CONFIG_DIR` / `--reticulum-config-dir` | Reticulum config dir |
272+
| Variable / flag | Purpose |
273+
| ---------------------------------------------------------- | -------------------------------------------------------------- |
274+
| `MESHCHAT_HOST` / `--host` | Bind address (default `127.0.0.1`) |
275+
| `MESHCHAT_PORT` / `--port` | Bind port (default `8000`) |
276+
| `MESHCHAT_HEADLESS` / `--headless` | Do not auto-launch a browser |
277+
| `MESHCHAT_STORAGE_DIR` / `--storage-dir` | App storage root |
278+
| `MESHCHAT_RETICULUM_CONFIG_DIR` / `--reticulum-config-dir` | Reticulum config dir |
279279
| `MESHCHAT_DATA_DIR` / `--data-dir` | Portable root for storage + Reticulum when those two are unset |
280-
| `MESHCHAT_PUBLIC_DIR` / `--public-dir` | Frontend assets dir |
281-
| `MESHCHAT_AUTH` / `--auth` | Enable web auth |
282-
| `MESHCHAT_NO_HTTPS` / `--no-https` | HTTP instead of HTTPS |
283-
| `MESHCHAT_SSL_CERT` + `MESHCHAT_SSL_KEY` | Custom TLS PEM pair (both required) |
284-
| `MESHCHAT_IDENTITY_FILE` / `BASE32` / `BASE64` | Seed identity from key material |
285-
| `MESHCHAT_AUTO_RECOVER` / `--auto-recover` | Attempt DB recovery on startup |
286-
| `MESHCHAT_EMERGENCY` / `--emergency` | Emergency mode (limited operation) |
287-
| `MESHCHAT_RESET_PASSWORD` / `--reset-password` | Clear password hash |
288-
| `MESHCHAT_DISABLE_PLUGINS` / `--disable-plugins` | Disable plugin system |
289-
| `MESHCHAT_LANDLOCK` | `1` / `0` / unset auto |
290-
| `MESHCHAT_SELF_CHECK` / `--self-check` | Run diagnostics and exit |
291-
| `MESHCHAT_MEMORY_DIAG` / `--memory-diag` | tracemalloc diagnostics |
292-
| `MESHCHAT_DISABLE_CSRF` | Dangerous. Tests/dev only |
293-
| `MESHCHAT_SKIP_STORAGE_LOCK` | Dangerous. Avoid overlapping instances carefully |
294-
| `MESHCHAT_RNS_LOG_LEVEL` | RNS log verbosity |
280+
| `MESHCHAT_PUBLIC_DIR` / `--public-dir` | Frontend assets dir |
281+
| `MESHCHAT_AUTH` / `--auth` | Enable web auth |
282+
| `MESHCHAT_NO_HTTPS` / `--no-https` | HTTP instead of HTTPS |
283+
| `MESHCHAT_SSL_CERT` + `MESHCHAT_SSL_KEY` | Custom TLS PEM pair (both required) |
284+
| `MESHCHAT_IDENTITY_FILE` / `BASE32` / `BASE64` | Seed identity from key material |
285+
| `MESHCHAT_AUTO_RECOVER` / `--auto-recover` | Attempt DB recovery on startup |
286+
| `MESHCHAT_EMERGENCY` / `--emergency` | Emergency mode (limited operation) |
287+
| `MESHCHAT_RESET_PASSWORD` / `--reset-password` | Clear password hash |
288+
| `MESHCHAT_DISABLE_PLUGINS` / `--disable-plugins` | Disable plugin system |
289+
| `MESHCHAT_LANDLOCK` | `1` / `0` / unset auto |
290+
| `MESHCHAT_SELF_CHECK` / `--self-check` | Run diagnostics and exit |
291+
| `MESHCHAT_MEMORY_DIAG` / `--memory-diag` | tracemalloc diagnostics |
292+
| `MESHCHAT_DISABLE_CSRF` | Dangerous. Tests/dev only |
293+
| `MESHCHAT_SKIP_STORAGE_LOCK` | Dangerous. Avoid overlapping instances carefully |
294+
| `MESHCHAT_RNS_LOG_LEVEL` | RNS log verbosity |
295295

296296
Restore helpers:
297297

‎docs/en/getting-started.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -79,14 +79,14 @@ Use the search bar to query both sets at once. MeshChatX guide text is currently
7979

8080
## Storage locations
8181

82-
| Data | Typical path (CLI default) |
83-
| --------------------- | -------------------------------------------------- |
84-
| MeshChatX app data | `./storage` (or `--storage-dir` / `MESHCHAT_STORAGE_DIR`) |
85-
| Reticulum config | `~/.reticulum` (or `--reticulum-config-dir` / `MESHCHAT_RETICULUM_CONFIG_DIR`) |
82+
| Data | Typical path (CLI default) |
83+
| --------------------- | ---------------------------------------------------------------------------------------------- |
84+
| MeshChatX app data | `./storage` (or `--storage-dir` / `MESHCHAT_STORAGE_DIR`) |
85+
| Reticulum config | `~/.reticulum` (or `--reticulum-config-dir` / `MESHCHAT_RETICULUM_CONFIG_DIR`) |
8686
| Portable bundle | `<data-dir>/storage` and `<data-dir>/.reticulum` when using `--data-dir` / `MESHCHAT_DATA_DIR` |
87-
| Desktop Electron data | `~/.reticulum-meshchatx` and `~/.reticulum` unless overridden at launch |
88-
| Per-identity database | `<storage>/identities/<identity_hash>/database.db` |
89-
| Docker volume | `meshchatx-config` mounted at `/config` |
87+
| Desktop Electron data | `~/.reticulum-meshchatx` and `~/.reticulum` unless overridden at launch |
88+
| Per-identity database | `<storage>/identities/<identity_hash>/database.db` |
89+
| Docker volume | `meshchatx-config` mounted at `/config` |
9090

9191
Legacy upstream data may still exist under `~/.reticulum-meshchat/`. Migration tooling can move you to the MeshChatX layout.
9292

‎docs/en/installation.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -130,23 +130,23 @@ Open the UI at the host and port you chose. HTTPS is enabled by default with a s
130130

131131
Common flags and environment variables:
132132

133-
| Flag | Environment variable | Default | Description |
134-
| ------------------------ | ------------------------ | -------------- | ---------------------------------- |
135-
| `--host` | `MESHCHAT_HOST` | `127.0.0.1` | Bind address |
136-
| `--port` | `MESHCHAT_PORT` | `8000` | HTTP or HTTPS port |
137-
| `--no-https` | `MESHCHAT_NO_HTTPS` | false | Serve plain HTTP |
138-
| `--ssl-cert` | `MESHCHAT_SSL_CERT` | auto | TLS certificate path |
139-
| `--ssl-key` | `MESHCHAT_SSL_KEY` | auto | TLS private key path |
140-
| `--headless` | `MESHCHAT_HEADLESS` | false | Do not open a browser |
141-
| `--auth` | `MESHCHAT_AUTH` | false | Require HTTP basic auth for the UI |
142-
| `--storage-dir` | `MESHCHAT_STORAGE_DIR` | `./storage` | Application data directory |
143-
| `--reticulum-config-dir` | `MESHCHAT_RETICULUM_CONFIG_DIR` | `~/.reticulum` | Reticulum configuration |
133+
| Flag | Environment variable | Default | Description |
134+
| ------------------------ | ------------------------------- | -------------- | ----------------------------------------------------------------------------------- |
135+
| `--host` | `MESHCHAT_HOST` | `127.0.0.1` | Bind address |
136+
| `--port` | `MESHCHAT_PORT` | `8000` | HTTP or HTTPS port |
137+
| `--no-https` | `MESHCHAT_NO_HTTPS` | false | Serve plain HTTP |
138+
| `--ssl-cert` | `MESHCHAT_SSL_CERT` | auto | TLS certificate path |
139+
| `--ssl-key` | `MESHCHAT_SSL_KEY` | auto | TLS private key path |
140+
| `--headless` | `MESHCHAT_HEADLESS` | false | Do not open a browser |
141+
| `--auth` | `MESHCHAT_AUTH` | false | Require HTTP basic auth for the UI |
142+
| `--storage-dir` | `MESHCHAT_STORAGE_DIR` | `./storage` | Application data directory |
143+
| `--reticulum-config-dir` | `MESHCHAT_RETICULUM_CONFIG_DIR` | `~/.reticulum` | Reticulum configuration |
144144
| `--data-dir` | `MESHCHAT_DATA_DIR` | none | Portable root (`storage` + `.reticulum` subdirs when the two paths above are unset) |
145-
| `--identity-file` | `MESHCHAT_IDENTITY_FILE` | none | Load identity from file |
146-
| `--rns-log-level` | `MESHCHAT_RNS_LOG_LEVEL` | none | Reticulum log level |
147-
| `--auto-recover` | `MESHCHAT_AUTO_RECOVER` | false | Attempt SQLite recovery on start |
148-
| `--emergency` | | false | Start without database |
149-
| `--disable-plugins` | | false | Disable the plugin system |
145+
| `--identity-file` | `MESHCHAT_IDENTITY_FILE` | none | Load identity from file |
146+
| `--rns-log-level` | `MESHCHAT_RNS_LOG_LEVEL` | none | Reticulum log level |
147+
| `--auto-recover` | `MESHCHAT_AUTO_RECOVER` | false | Attempt SQLite recovery on start |
148+
| `--emergency` | | false | Start without database |
149+
| `--disable-plugins` | | false | Disable the plugin system |
150150

151151
CLI flags override environment variables when both are set.
152152

‎meshchatx.rsm‎

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)