From 49f6f8c3374a7e70ef069292e388e293ec0bdc0d Mon Sep 17 00:00:00 2001 From: neha_gupta Date: Mon, 17 Jul 2023 21:49:21 +0530 Subject: [PATCH] config info in doc (#3796) - Use single inverted comma instead of double inverted comma in Powershell env vars. - Update config file information in docs. #### Does this PR need a docs update or release note? - [ ] :no_entry: No #### Type of change - [ ] :world_map: Documentation #### Issue(s) * https://github.com/alcionai/corso/issues/3522 #### Test Plan - [ ] :muscle: Manual - [ ] :zap: Unit test - [ ] :green_heart: E2E --- website/docs/setup/configuration.md | 73 ++++++++++++++++++++++++++--- website/docs/setup/m365-access.md | 6 +-- website/docs/setup/repos.md | 2 +- 3 files changed, 71 insertions(+), 10 deletions(-) diff --git a/website/docs/setup/configuration.md b/website/docs/setup/configuration.md index 65c04e99b..9808b3f30 100644 --- a/website/docs/setup/configuration.md +++ b/website/docs/setup/configuration.md @@ -10,6 +10,13 @@ Two things are needed to configure Corso: * Environment variables containing configuration information * A directory for Corso to store its configuration file +Apart from Environment variables configuration information can also be provided from flags or configuration files. +Corso uses the following priority order for configuration: + +1. Flags values +2. Environment variables +3. Configuration File information + ## Environment variables Three distinct pieces of configuration are required by Corso: @@ -34,15 +41,15 @@ alternate ways to pass AWS credentials. Ensure that all of the above environment variables are defined in your Powershell environment. ```powershell - $Env:AWS_ACCESS_KEY_ID = "..." - $Env:AWS_SECRET_ACCESS_KEY = "..." + $Env:AWS_ACCESS_KEY_ID = '...' + $Env:AWS_SECRET_ACCESS_KEY = '...' $Env:AWS_SESSION_TOKEN = "" - $Env:AZURE_CLIENT_ID = "..." - $Env:AZURE_TENANT_ID = "..." - $Env:AZURE_CLIENT_SECRET = "..." + $Env:AZURE_CLIENT_ID = '...' + $Env:AZURE_TENANT_ID = '...' + $Env:AZURE_CLIENT_SECRET = '...' - $Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE" + $Env:CORSO_PASSPHRASE = 'CHANGE-ME-THIS-IS-INSECURE' ``` @@ -105,12 +112,48 @@ To create the environment variables file, you can run the following command: By default, Corso stores its configuration file (`.corso.toml`) in the user's home directory. The location of the configuration file can be specified using the `--config-file` option. +The config file can also be used to provide other configuration information like Azure and AWS credentials as mentioned below: + + ```bash + # AWS configs + aws_access_key_id = '...' + aws_secret_access_key = '...' + aws_session_token = '...' + + # M365 config + account_provider = '...' + azure_tenantid = '...' + azure_client_id = '...' + azure_secret = '...' + + # Corso passphrase + passphrase = '...' +``` + By default, Corso stores its configuration file (`.corso.toml`) in the user's home directory. The location of the configuration file can be specified using the `--config-file` option. +The config file can also be used to provide other configuration information like Azure and AWS credentials as mentioned below: + + ```bash + # AWS configs + aws_access_key_id = '...' + aws_secret_access_key = '...' + aws_session_token = '...' + + # M365 config + account_provider = '...' + azure_tenantid = '...' + azure_client_id = '...' + azure_secret = '...' + + # Corso passphrase + passphrase = '...' +``` + @@ -124,6 +167,24 @@ directory within the container. ` } +The config file can also be used to provide other configuration information like Azure and AWS credentials as mentioned below: + + ```bash + # AWS configs + aws_access_key_id = '...' + aws_secret_access_key = '...' + aws_session_token = '...' + + # M365 config + account_provider = '...' + azure_tenantid = '...' + azure_client_id = '...' + azure_secret = '...' + + # Corso passphrase + passphrase = '...' +``` + diff --git a/website/docs/setup/m365-access.md b/website/docs/setup/m365-access.md index 21e42f3e6..1ec66955d 100644 --- a/website/docs/setup/m365-access.md +++ b/website/docs/setup/m365-access.md @@ -85,8 +85,8 @@ Copy the client and tenant IDs and export them into the following environment va ```powershell - $Env:AZURE_CLIENT_ID = "" - $Env:AZURE_TENANT_ID = "" + $Env:AZURE_CLIENT_ID = '' + $Env:AZURE_TENANT_ID = '' ``` @@ -124,7 +124,7 @@ environment variable. ```powershell - $Env:AZURE_CLIENT_SECRET = "" + $Env:AZURE_CLIENT_SECRET = '' ``` diff --git a/website/docs/setup/repos.md b/website/docs/setup/repos.md index 3c2a7c119..5615c8c84 100644 --- a/website/docs/setup/repos.md +++ b/website/docs/setup/repos.md @@ -83,7 +83,7 @@ Before first use, you need to initialize a Corso repository with `corso repo ini ```powershell # Initialize the Corso Repository - $Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE" + $Env:CORSO_PASSPHRASE = 'CHANGE-ME-THIS-IS-INSECURE' .\corso repo init s3 --bucket corso-test ```