Small changes to quickstart/variables docs

Author: tcompa

docs/environment-variables.md

@@ -4,23 +4,23 @@ The following environment variables can be used to configure fractal-web.
 
 > Only when using `npm run dev` or `npm run preview` these variables are automatically read from `.env.development` and `.env` files. In production they must be set in the shell that starts the node process.
 
-* `FRACTAL_SERVER_HOST`: represents the URL of the fractal-server application (e.g. http://localhost:8000); this variable is **required** and it should not contain a final slash;
+* `FRACTAL_SERVER_HOST`: represents the URL of the fractal-server application (e.g. http://localhost:8000, or http://subdomain.example.org:8000); this variable is **required** and it should not contain a final slash;
 * `AUTH_COOKIE_NAME`: the name of the cookie used to store the user session; the default value is `fastapiusersauth`;
 * `AUTH_COOKIE_DOMAIN`: specifies which server can receive the cookie; **remember to set it in production**;
 * `AUTH_COOKIE_PATH`: the URL path where the cookie will be available; the default value is `/`;
 * `AUTH_COOKIE_SECURE`: sends the cookie only if the server is using HTTPS; the default value is `true`, can be set to `false` during development;
 * `AUTH_COOKIE_SAME_SITE`: set the [SameSite](https://web.dev/articles/samesite-cookies-explained) attribute to the cookie; the default value is `lax`;
 * `PUBLIC_FRACTAL_ADMIN_SUPPORT_EMAIL`: the e-mail address displayed in the home page which can be used to send support requests; if the value is not set nothing is shown;
 * `PUBLIC_UPDATE_JOBS_INTERVAL`: the delay in milliseconds which occurs between two background requests that check for job status updates; the default value is `3000`;
-* `PUBLIC_OAUTH_CLIENT_NAME`: if set, the application enables the external account login via OAuth2; the name is used to create the authorization call sent to fractal-server;
+* `PUBLIC_OAUTH_CLIENT_NAME`: if set, the application enables the external account login via OAuth2; the name is used to create the authorization call sent to fractal-server (see [configuration page](../oauth2/));
 * `LOG_FILE`: the path of the file where logs will be written; by default is unset and no file will be created;
 * `LOG_LEVEL_FILE`: the log level of logs that will be written to the file; the default value is `info`;
 * `LOG_LEVEL_CONSOLE`: the log level of logs that will be written to the console; the default value is `warn`.
 
 When running directly using `node` command these extra variables can also be configured:
 
 * `PORT`: specifies the port where Svelte server will run; the default value is 5173;
-* `ORIGIN` the URL where the app will be served (e.g. http://localhost:5173).
+* `ORIGIN` the URL where the app will be served (e.g. http://localhost:5173, or https://subdomain.example.org).
 
 ## Common issues related to environment variables
 

docs/quickstart.md

@@ -26,7 +26,7 @@ FRACTAL_WEB_VERSION=1.1.0 && NODE_MAJOR_VERSION=20 && wget -qO- "https://github.
 
 **Note**: this will unpack in the current working directory the file `package.json` and the folders `build` and `node_modules`.
 
-To start the application installed in this way see the section "Run fractal-web from the build folder".
+To start the application installed in this way see the section [Run fractal-web from the build folder](#run-fractal-web-from-the-build-folder) below.
 
 ## Set environment variables
 
@@ -44,17 +44,16 @@ You can create a script with the following content to run fractal-web installed
 export FRACTAL_SERVER_HOST=http://localhost:8000
 export PUBLIC_FRACTAL_ADMIN_SUPPORT_EMAIL=help@localhost
 export PUBLIC_OAUTH_CLIENT_NAME=
-# remember to set this in production
+# remember to set this in production (e.g. subdomain.example.org)
 export AUTH_COOKIE_DOMAIN=
-# set this to true in production
-export AUTH_COOKIE_SECURE=false
 
 export ORIGIN=http://localhost:5173
 export PORT=5173
 
 export LOG_FILE=fractal-web.log
-export LOG_LEVEL_FILE=info
-export LOG_LEVEL_CONSOLE=warn
+# default values for logging levels (uncomment if needed)
+# export LOG_LEVEL_FILE=info
+# export LOG_LEVEL_CONSOLE=warn
 
 # default values are usually fine for the following variables; remove comments if needed
 #export AUTH_COOKIE_NAME=fastapiusersauth