xiretza/factoriauth
1
0
Fork 0
Code Issues 2 Pull requests Releases Activity

Update README

Browse source
This commit is contained in:
Xiretza 2024-02-10 22:11:39 +00:00
parent e0c12f4c14
commit 988afff71d
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -41,7 +41,7 @@ these custom users are properly authenticated.
### Configuring factoriauth
TBD
Copy `config.toml.example` to `config.toml` and adjust as necessary.
### Configuring clients/servers
@ -53,7 +53,7 @@ To use the auth server, the following snippet needs to be added to the clients'
auth-server=https://my-auth-server.example/
```
Unless your clients are really offline, you also need to override the updater server to an
NOTE: If a client isn't entirely offline, you also need to override the updater server to an
invalid/unreachable address, otherwise the client will contact it with an invalid token on startup
and prompt for a re-login:
@ -64,4 +64,5 @@ updater-server=http://invalid.example
### Running factoriauth
TBD
Either use `cargo install --path .` and follow its instructions for how to update `$PATH`, then run
`factoriauth`, or run the program straight from the repository: `cargo run`.