diff options
| author | salmonik <salmonik@tuta.io> | 2026-11-01 16:26:21 +0100 |
|---|---|---|
| committer | salmonik <salmonik@tuta.io> | 2026-11-01 16:26:21 +0100 |
| commit | a036e7eb46886ff7fe88255ae26c327f63ec4bfa (patch) | |
| tree | 494911ce0d394041c00eff276632e4f5f48f3fb5 /docs | |
| parent | v3.2.0: straight and split bets anywhere on the felt; add history command (diff) | |
| download | zagan-bet-a036e7eb46886ff7fe88255ae26c327f63ec4bfa.tar.gz zagan-bet-a036e7eb46886ff7fe88255ae26c327f63ec4bfa.zip | |
v3.3.0: keep client.db in the XDG data dir, add -d/--data-dir
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/SERVER_SETUP.md | 4 | ||||
| -rw-r--r-- | docs/TESTING.md | 12 |
2 files changed, 11 insertions, 5 deletions
diff --git a/docs/SERVER_SETUP.md b/docs/SERVER_SETUP.md index 9eac7a7..700a12e 100644 --- a/docs/SERVER_SETUP.md +++ b/docs/SERVER_SETUP.md | |||
| @@ -79,7 +79,9 @@ last address for that key is forgotten. | |||
| 79 | 79 | ||
| 80 | The server creates `server.db` in the current directory on first use. It holds | 80 | The server creates `server.db` in the current directory on first use. It holds |
| 81 | users, balances, and the per-game `plays` audit. The client keeps its own | 81 | users, balances, and the per-game `plays` audit. The client keeps its own |
| 82 | `client.db` for host fingerprints and stored credentials. There are no schema | 82 | `client.db` for host fingerprints and stored credentials in |
| 83 | `$XDG_DATA_HOME/zagan-bet/` (usually `~/.local/share/zagan-bet/`); pass | ||
| 84 | `-d <dir>` to keep it somewhere else. There are no schema | ||
| 83 | migrations while the app is in alpha: a schema change means deleting both files. | 85 | migrations while the app is in alpha: a schema change means deleting both files. |
| 84 | 86 | ||
| 85 | During development, delete both files to reset users, balances, history, and | 87 | During development, delete both files to reset users, balances, history, and |
diff --git a/docs/TESTING.md b/docs/TESTING.md index ac07a3f..1a1d369 100644 --- a/docs/TESTING.md +++ b/docs/TESTING.md | |||
| @@ -52,12 +52,16 @@ on a machine where the `openssl` CLI is available. | |||
| 52 | 52 | ||
| 53 | ## Development resets | 53 | ## Development resets |
| 54 | 54 | ||
| 55 | The server creates `server.db` in its working directory; the client creates | 55 | The server creates `server.db` in its working directory. The client keeps |
| 56 | `client.db` for host trust and stored credentials. While the software is in | 56 | `client.db` (host trust, stored credentials) in the XDG data directory: |
| 57 | testing, delete both after a schema or trust change: | 57 | `$XDG_DATA_HOME/zagan-bet/client.db`, usually |
| 58 | `~/.local/share/zagan-bet/client.db`. Override it with `client -d <dir>`. | ||
| 59 | |||
| 60 | While the software is in testing, delete both after a schema or trust change: | ||
| 58 | 61 | ||
| 59 | ```sh | 62 | ```sh |
| 60 | rm -f server.db client.db | 63 | rm -f server.db |
| 64 | rm -rf ~/.local/share/zagan-bet | ||
| 61 | ``` | 65 | ``` |
| 62 | 66 | ||
| 63 | The audit schema is not auto-migrated from the pre-2.0 slots-only `plays` | 67 | The audit schema is not auto-migrated from the pre-2.0 slots-only `plays` |
