From 988afff71d771d059ab4855f21c5e73d556ccd4f Mon Sep 17 00:00:00 2001 From: Xiretza Date: Sat, 10 Feb 2024 22:11:39 +0000 Subject: [PATCH] Update README --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a6bae98..85f2802 100644 --- a/README.md +++ b/README.md @@ -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`.