From 94192739a4d8487d666c69be2d5e6be9ea6dd1a7 Mon Sep 17 00:00:00 2001 From: jwijenbergh Date: Tue, 26 Apr 2022 16:37:19 +0200 Subject: Docs: Update debugging --- docs/src/gettingstarted/debugging/fsm.md | 2 +- docs/src/gettingstarted/debugging/fsm_example.png | Bin 331875 -> 62025 bytes docs/src/gettingstarted/debugging/logging.md | 4 ++-- 3 files changed, 3 insertions(+), 3 deletions(-) (limited to 'docs/src') diff --git a/docs/src/gettingstarted/debugging/fsm.md b/docs/src/gettingstarted/debugging/fsm.md index 891b0ea..65ff031 100644 --- a/docs/src/gettingstarted/debugging/fsm.md +++ b/docs/src/gettingstarted/debugging/fsm.md @@ -21,7 +21,7 @@ The states mean the following: - `NO_SERVER`: The client is registered, but has not chosen a server yet - `CHOSEN_SERVER`: The client has chosen a server to connect to - `OAuth_Started`: The OAuth process has been started. This means that the client needs to redirect to the browser so that the user can login and approve the application -- `Authenticated`: The OAuth process has finished. The client now has tokens and is thus authenticated +- `Authorized`: The OAuth process has finished. The client now has tokens and is thus authorized - `Request_Config`: The client is in the process of requesting an OpenVPN/Wireguard configuration from the server - `Ask_Profile`: The server has multiple profiles for which a config can be obtained, the client must show an UI of the profiles. The user then selects one of these profiles to exit this state - `Has_Config`: The client now has a configuration that it can use to connect using OpenVPN/Wireguard diff --git a/docs/src/gettingstarted/debugging/fsm_example.png b/docs/src/gettingstarted/debugging/fsm_example.png index c495124..7b68d8e 100644 Binary files a/docs/src/gettingstarted/debugging/fsm_example.png and b/docs/src/gettingstarted/debugging/fsm_example.png differ diff --git a/docs/src/gettingstarted/debugging/logging.md b/docs/src/gettingstarted/debugging/logging.md index a1cfc97..9a7eae2 100644 --- a/docs/src/gettingstarted/debugging/logging.md +++ b/docs/src/gettingstarted/debugging/logging.md @@ -2,7 +2,7 @@ As said, logging is used. The logging gets saved in a client-specified directory (see [API](../../api/index.html)). Logging has the following levels: - `INFO`: Messages purely for info, these do not indicate any errors. They are merely there for debugging purposes -- `WARNING`: This message indicates a warning, this can be e.g. non-fatal errors -- `ERROR`: Fatal errors which refuses the app from working +- `WARNING`: These messages indicate a warning, e.g. non-fatal errors +- `ERROR`: Fatal errors which refuses the app from working correctly By default only messages below or equal to `WARNING` are logged (`WARNING`, `ERROR`). However, if the debug variable is set to `True`, all messages will be logged into the log file. -- cgit v1.2.3