diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index f7fd5ddd1..5bd8cf209 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -46,8 +46,11 @@ Corso. ## Repository creation -To create a secure backup location for Corso, we will create a bucket (`corso-test` is used as an example) in AWS S3. -The following commands assume that all configuration values from the previous step, `AWS_ACCESS_KEY_ID`, and +To create a secure backup location for Corso, you will create a bucket in AWS S3 and then initialize the Corso +repository using an [encryption passphrase](/setup/configuration#environment-variables). The steps below use +`corso-test` as the bucket name but, if you are using AWS, you will need a different unique name for the bucket. + +The following commands assume that all the configuration values from the previous step, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY` are available to the Corso binary or container. @@ -56,32 +59,7 @@ The following commands assume that all configuration values from the previous st ```powershell # Create the AWS S3 Bucket aws s3api create-bucket --bucket corso-test - ``` - - - - ```bash - # Create the AWS S3 Bucket - aws s3api create-bucket --bucket corso-test - ``` - - - - - ```bash - # Create the AWS S3 Bucket - aws s3api create-bucket --bucket corso-test - ``` - - - - -Next, let's initialize the Corso repository using an encryption passphrase. - - - - ```powershell # Initialize the Corso Repository $Env:CORSO_PASSPHRASE = "CHANGE-ME-THIS-IS-INSECURE" .\corso.exe repo init s3 --bucket corso-test @@ -91,6 +69,9 @@ Next, let's initialize the Corso repository using an encryption passphrase. ```bash + # Create the AWS S3 Bucket + aws s3api create-bucket --bucket corso-test + # Initialize the Corso Repository export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" corso repo init s3 --bucket corso-test @@ -100,37 +81,81 @@ Next, let's initialize the Corso repository using an encryption passphrase. ```bash + # Create the AWS S3 Bucket + aws s3api create-bucket --bucket corso-test + + # Create an environment variables file + mkdir -p $HOME/.corso + cat < $HOME/.corso/corso.env + CORSO_PASSPHRASE + AZURE_TENANT_ID + AZURE_CLIENT_ID + AZURE_CLIENT_SECRET + AWS_ACCESS_KEY_ID + AWS_SECRET_ACCESS_KEY + AWS_SESSION_TOKEN + EOF + # Initialize the Corso Repository export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" - docker run --env-file ~/.corso/corso.env \ - --volume $HOME/.corso:/app/corso corso/corso:latest \ + docker run --env-file $HOME/.corso/corso.env \ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ repo init s3 --bucket corso-test ``` -## Your first backup +## Creating your first backup -Corso can do much more, but you can start by creating a backup of your Exchange mailbox. +Corso can do much more, but you can start by creating a backup of your Exchange mailbox. To do this, first ensure that +you are connected with the repository and then backup your own Exchange mailbox. -To do this, you can run the following command: + + -```bash -$ docker run -e CORSO_PASSPHRASE \ - --env-file ~/.corso/corso.env \ - -v ~/.corso:/app/corso corso/corso: \ + ```powershell + # Connect to the Corso Repository + .\corso.exe repo connect s3 --bucket corso-test + + # Backup your inbox + .\corso.exe backup create exchange --user + ``` + + + + + ```bash + # Connect to the Corso Repository + corso repo connect s3 --bucket corso-test + + # Backup your inbox + corso backup create exchange --user + ``` + + + + + ```bash + # Connect to the Corso Repository + docker run --env-file $HOME/.corso/corso.env \ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ + repo connect s3 --bucket corso-test + + # Backup your inbox + docker run --env-file $HOME/.corso/corso.env \ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ backup create exchange --user + ``` - Started At ID Status Selectors - 2022-10-10T19:46:43Z 41e93db7-650d-44ce-b721-ae2e8071c728 Completed (0 errors) alice@example.com -``` + + :::note Your first backup may take some time if your mailbox is large. ::: -## Restore an email +## Restoring an email Now lets explore how you can restore data from one of your backups. diff --git a/docs/docs/setup/configuration.md b/docs/docs/setup/configuration.md index dcc41e40f..12220411d 100644 --- a/docs/docs/setup/configuration.md +++ b/docs/docs/setup/configuration.md @@ -48,7 +48,8 @@ To create the environment variables file, you can run the following command: ```bash # Create an environment variables file - cat < ~/.corso/corso.env + mkdir -p $HOME/.corso + cat < $HOME/.corso/corso.env CORSO_PASSPHRASE AZURE_TENANT_ID AZURE_CLIENT_ID @@ -73,7 +74,7 @@ The location of the configuration file can be specified using the `--config-file -By default, Corso store its configuration file (`.corso.toml`) in the root of the home directory. +By default, Corso stores its configuration file (`.corso.toml`) in the root of the home directory. The location of the configuration file can be specified using the `--config-file` option. @@ -84,9 +85,9 @@ to read or create its configuration file (`.corso.toml`). This directory must be directory within the container. ```bash -$ docker run --env-file ~/.corso/corso.env \ - --volume ~/.corso/corso:/app/corso \ - corso/corso +$ docker run --env-file $HOME/.corso/corso.env \ + --volume $HOME/.corso/corso:/app/corso \ + ghcr.io/alcionai/corso ```