Skip to content

Commit

Permalink
fix links; update new env variables
Browse files Browse the repository at this point in the history
  • Loading branch information
pieroit committed Aug 1, 2024
1 parent 8b1ccc8 commit cbbf530
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 2 deletions.
4 changes: 2 additions & 2 deletions mkdocs/plugins/logging.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Logging System

The `CCAT_LOG_LEVEL` environment variable is used to manage the default logging level of the Cat. Take a look at Cat's environment variable [here](/production/administrators/env-variables/#ccat_log_level).
The `CCAT_LOG_LEVEL` environment variable is used to manage the default logging level of the Cat. Take a look at Cat's environment variable [here](./../production/administrators/env-variables.md#ccat_log_level).

The available values for *level* are:

Expand Down Expand Up @@ -28,7 +28,7 @@ log.info(f"Value of user message is {user_message_json["text"]}")
log.critical(variable_value)
```

Take a look [here](https://cheshire-cat-ai.github.io/docs///API_Documentation/log/) if you want to better understand how the log system is implemented.
Take a look [here](https://cheshire-cat-ai.github.io/docs/API_Documentation/log/) if you want to better understand how the log system is implemented.

## Examples

Expand Down
26 changes: 26 additions & 0 deletions mkdocs/production/administrators/env-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,32 @@ Default value: `cat/data/metadata.json`

The name of the file that contains all the Cat settings.


### CCAT_JWT_SECRET
Default value: `secret`

Secret for issueing and validating JWTs. Must be personalized along `CCAT_API_KEY` and `CCAT_APIKEY_WS` to make the installation secure.

### CCAT_JWT_ALGORITHM
Default value: `HS256`

Algorithm to sign the JWT with `CCAT_JWT_SECRET`.

### CCAT_JWT_EXPIRE_MINUTES
Default value: `1440`

By default a JWT expires after 1 day.

### CCAT_HTTPS_PROXY_MODE
Default value: `false`

Enable this variable if you are using a proxy like Nginx with SSL in front of the Cat, otherwise https will give redirection problems.

### CCAT_CORS_FORWARDED_ALLOW_IPS
Default value: `*`

TODO: exaplin this env

### CCAT_SAVE_MEMORY_SNAPSHOTS
Default value: `false`

Expand Down

0 comments on commit cbbf530

Please sign in to comment.