From ce061d8765e0a828918d5f53fc6aebc87779c0dc Mon Sep 17 00:00:00 2001 From: Niraj Tolia Date: Fri, 21 Oct 2022 09:22:01 -0700 Subject: [PATCH] Pin more Docker versions (#1286) ## Description Fix a few places where we refer to `latest` ## Type of change - [x] :bug: Bugfix - [x] :world_map: Documentation --- docs/docs/quickstart.md | 92 ++++++++++++++++++++++------------------ docs/docs/setup/repos.md | 31 +++++++------- 2 files changed, 66 insertions(+), 57 deletions(-) diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index c5374808e..5094ec044 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -1,8 +1,10 @@ # Quick start +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import TOCInline from '@theme/TOCInline'; +import {Version} from '@site/src/corsoEnv'; This quick start guide runs through the steps you can follow to create your first Microsoft 365 backup and restore: @@ -76,25 +78,31 @@ Corso binary or container. - ```bash - # Create an environment variables file - mkdir -p $HOME/.corso - cat < $HOME/.corso/corso.env - CORSO_PASSPHRASE - AZURE_CLIENT_ID - AZURE_TENANT_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 $HOME/.corso/corso.env \ - --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ - repo init s3 --bucket corso-test - ``` +{ +`# Create an environment variables file +mkdir -p $HOME/.corso +cat < $HOME/.corso/corso.env +CORSO_PASSPHRASE +AZURE_CLIENT_ID +AZURE_TENANT_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 $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + repo init s3 --bucket corso-test` +} + + + @@ -123,12 +131,12 @@ you initialized the Corso repository, you might need to [connect to it again](/s - ```bash - # 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 - ``` +{ +`# Backup your inbox +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + backup create exchange --user ` +} @@ -169,12 +177,12 @@ You can see all Exchange backups available with the following command: - ```bash - # List all Exchange backups - docker run --env-file $HOME/.corso/corso.env \ - --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ - backup list exchange - ``` +{ +`# List all Exchange backups +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + backup list exchange` +} @@ -207,12 +215,12 @@ Next, select one of the available backups and list all backed up emails. See - ```bash - # List emails in a selected backup - docker run --env-file $HOME/.corso/corso.env \ - --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ - backup details exchange --backup --email "*" | head - ``` +{ +`# List emails in a selected backup +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + backup details exchange --backup --email "*" | head` +} @@ -248,12 +256,12 @@ When you are ready to restore the selected email, use the following command. - ```bash - # Restore a selected email - docker run --env-file $HOME/.corso/corso.env \ - --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ - restore exchange --backup --email - ``` +{ +`# Restore a selected email +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + restore exchange --backup --email ` +} diff --git a/docs/docs/setup/repos.md b/docs/docs/setup/repos.md index 7199ba686..fd542516a 100644 --- a/docs/docs/setup/repos.md +++ b/docs/docs/setup/repos.md @@ -4,14 +4,15 @@ description: "Configure backup repository" # Repositories +import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import TOCInline from '@theme/TOCInline'; +import {Version} from '@site/src/corsoEnv'; A Corso [repository](concepts#corso-concepts) stores encrypted copies of your backup data. Repositories are supported on the following object storage systems: -import TOCInline from '@theme/TOCInline'; -
:::note @@ -89,13 +90,13 @@ Before first use, you need to initialize a Corso repository with `corso repo ini - ```bash - # Initialize the Corso Repository - export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" - docker run --env-file $HOME/.corso/corso.env \ - --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ - repo init s3 --bucket corso-test - ``` +{ +`# Initialize the Corso Repository +export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + repo init s3 --bucket corso-test` +} @@ -124,12 +125,12 @@ If a repository already exists, you can connect to it with `corso repo connect s - ```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 - ``` +{ +`# Connect to the Corso Repository +docker run --env-file $HOME/.corso/corso.env \\ + --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\ + repo connect s3 --bucket corso-test` +}