From c8befc56080ce62d1c226608002eab99be67f0c9 Mon Sep 17 00:00:00 2001
From: Manuel Sopena Ballesteros <manuel.sopena@cscs.ch>
Date: Wed, 3 Jul 2024 16:14:03 +0200
Subject: [PATCH] refactor: update documentation

---
 docs/audit.md         |  9 +++++++++
 docs/configuration.md | 14 +++++---------
 mkdocs.yml            |  1 +
 3 files changed, 15 insertions(+), 9 deletions(-)
 create mode 100644 docs/audit.md

diff --git a/docs/audit.md b/docs/audit.md
new file mode 100644
index 00000000..bdb51e57
--- /dev/null
+++ b/docs/audit.md
@@ -0,0 +1,9 @@
+# Audit
+
+Manta can log user's operations in `/var/log/manta/` (Linux) or `${PWD}` (MacOS), please make sure this folder exists and the current user has `rwx` access to it
+
+```bash
+mkdir /var/log/manta
+chmod 777 -R /var/log/manta
+```
+
diff --git a/docs/configuration.md b/docs/configuration.md
index 1d49a6b9..1a1dce04 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -2,15 +2,15 @@
 
 ## Configuration
 
-Manta follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) ([folder mapping per OS](https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c#correlations)) to find files. The configuration file needs to be under `$XDG_CONFIG_HOME/manta/` folder.
+By default, Manta follows the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) ([folder mapping per OS](https://gist.github.com/roalcantara/107ba66dfa3b9d023ac9329e639bc58c#correlations)) to find files. The configuration file needs to be under `$XDG_CONFIG_HOME/manta/` folder.
 
-Manta configuration file can be found under one of the following locations:
+By default, Manta configuration file can be found under one of the following locations:
 
 > - Linux: $HOME/.config/manta/config.toml
 > - MacOS: $HOME/Library/Application Support/manta/config.toml
 
 ```bash
-mkdir -p ~/.config/manta
+mkdir -p /home/msopena/.config/manta
 
 cat >> ~/.config/manta/config.toml <<EOF
 log = "info"
@@ -32,17 +32,13 @@ root_ca_cert_file = "alps_root_cert.pem"
 EOF
 ```
 
-Manta can log user's operations in `/var/log/manta/` (Linux) or `${PWD}` (MacOS), please make sure this folder exists and the current user has `rwx` access to it
-
-```bash
-mkdir /var/log/manta
-chmod 777 -R /var/log/manta
-```
+Alternatively, an environment variable could be used to tell Manta where to find the configuration file `MANTA_CONFIG=/home/msopena/my_config.toml manta config show`
 
 ## Legend:
 
 | Name                                | mandatory   | Type                          | Description                                                                                                                                                          | Example                               |
 | ----------------------------------- | ----------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
+| MANTA_CONFIG                        | no          | env                           | path to manta configuration file. If missing, then `$XDG_CONFIG/manta/confog.toml` will be used                                                                      | $HOME/my_confog.toml                  |
 | MANTA_CSM_TOKEN                     | no          | env                           | CSM authentication token, if this env var is missing, then manta will prompt use for credentials against CSM keycloak                                                |                                       |
 | log                                 | no          | config file                   | log details/verbosity                                                                                                                                                | off/error/warn/info/debug/trace       |
 | hsm_group                           | no          | config                        | If exists, then it will filter/restrict the hsm groups and/or xnames targeted by the cli command                                                                     | psi-dev                               |
diff --git a/mkdocs.yml b/mkdocs.yml
index 6c7f64d0..0b878efc 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -13,6 +13,7 @@ nav:
   - Basic Operations: basic_operations.md
   - Cluster mgmt with SAT file: cluster_mgmt_with_sat_file.md
   - Cluster migration: cluster_migration.md
+  - Audit: audit.md
   - Security: security.md
   - FAQ: faq.md