GothenburgBitFactory/taskchampion-sync-server
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/taskchampion-sync-server.git synced 2025-08-01 20:20:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

suggestion from @ryneeverett

Browse source
This commit is contained in:
Dustin J. Mitchell 2025-07-12 09:48:15 -04:00
parent 0a71cce2d1
commit 67576fe382
No known key found for this signature in database
1 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -85,16 +85,20 @@ list of values.
The `--data-dir` option specifies where the server should store its data. This
value can be specified in the environment variable `DATA_DIR`.
By default, the server allows all client IDs. To limit the accepted client IDs,
specify them in the environment variable `CLIENT_ID`, as a comma-separated list
of UUIDs. Client IDs can be specified with `--allow-client-id`, but this should
not be used on shared systems, as command line arguments are visible to all
users on the system.
By default, the server will allow all clients and create them in the database
on first contact. There are two ways to limit the clients the server will
interact with:
By default, the server will create clients on first contact, so it is easy to
start from an empty database. If you are managing clients in the database
through some other means, disable this behavior with `--no-create-clients` or
`CREATE_CLIENTS=false`.
- To limit the accepted client IDs, specify them in the environment variable
`CLIENT_ID`, as a comma-separated list of UUIDs. Client IDs can be specified
with `--allow-client-id`, but this should not be used on shared systems, as
command line arguments are visible to all users on the system. This convenient
option is suitable for personal and small-scale deployments.
- To disable the automatic creation of clients, use the `--no-create-clients`
flag or the `CREATE_CLIENTS=false` environment variable. You are now
responsible for creating clients in the database manually, so this option is
more suitable for large scale deployments.
The server only logs errors by default. To add additional logging output, set
environment variable `RUST_LOG` to `info` to get a log message for every