larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Pin more Docker versions (#1286)

Browse Source 
## Description

Fix a few places where we refer to `latest`

## Type of change

- [x] 🐛 Bugfix
- [x] 🗺️ Documentation
This commit is contained in:
Niraj Tolia 2022-10-21 09:22:01 -07:00 committed by GitHub
parent 9dc53bd9f8
commit ce061d8765
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 66 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
docs/docs/quickstart.md
View File

@ -1,8 +1,10 @@
# Quick start # Quick start
import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
import TOCInline from '@theme/TOCInline'; 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: 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.
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <!-- vale Vale.Spelling = NO -->
# Create an environment variables file <!-- markdownlint-disable MD022 MD025 MD033 -->
mkdir -p $HOME/.corso
cat <<EOF > $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 <CodeBlock language="bash">{
export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" `# Create an environment variables file
docker run --env-file $HOME/.corso/corso.env \ mkdir -p $HOME/.corso
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ cat <<EOF > $HOME/.corso/corso.env
repo init s3 --bucket corso-test 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`
}</CodeBlock>
<!-- markdownlint-enable MD022 MD025 MD033 -->
<!-- vale Vale.Spelling = YES -->
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -123,12 +131,12 @@ you initialized the Corso repository, you might need to [connect to it again](/s
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# Backup your inbox `# Backup your inbox
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
backup create exchange --user <your exchange email address> backup create exchange --user <your exchange email address>`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -169,12 +177,12 @@ You can see all Exchange backups available with the following command:
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# List all Exchange backups `# List all Exchange backups
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
backup list exchange backup list exchange`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -207,12 +215,12 @@ Next, select one of the available backups and list all backed up emails. See
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# List emails in a selected backup `# List emails in a selected backup
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
backup details exchange --backup <id of your selected backup> --email "*" | head backup details exchange --backup <id of your selected backup> --email "*" | head`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -248,12 +256,12 @@ When you are ready to restore the selected email, use the following command.
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# Restore a selected email `# Restore a selected email
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
restore exchange --backup <id of your selected backup> --email <email reference> restore exchange --backup <id of your selected backup> --email <email reference>`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>

31
docs/docs/setup/repos.md
View File

@ -4,14 +4,15 @@ description: "Configure backup repository"
# Repositories # Repositories
import CodeBlock from '@theme/CodeBlock';
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; 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 A Corso [repository](concepts#corso-concepts) stores encrypted copies of your backup data. Repositories are
supported on the following object storage systems: supported on the following object storage systems:
import TOCInline from '@theme/TOCInline';
<TOCInline toc={toc} maxHeadingLevel={2}/><br/> <TOCInline toc={toc} maxHeadingLevel={2}/><br/>
:::note :::note
@ -89,13 +90,13 @@ Before first use, you need to initialize a Corso repository with `corso repo ini
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# Initialize the Corso Repository `# Initialize the Corso Repository
export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE" export CORSO_PASSPHRASE="CHANGE-ME-THIS-IS-INSECURE"
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
repo init s3 --bucket corso-test repo init s3 --bucket corso-test`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>
@ -124,12 +125,12 @@ If a repository already exists, you can connect to it with `corso repo connect s
</TabItem> </TabItem>
<TabItem value="docker" label="Docker"> <TabItem value="docker" label="Docker">
```bash <CodeBlock language="bash">{
# Connect to the Corso Repository `# Connect to the Corso Repository
docker run --env-file $HOME/.corso/corso.env \ docker run --env-file $HOME/.corso/corso.env \\
--volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:latest \ --volume $HOME/.corso:/app/corso ghcr.io/alcionai/corso:${Version()} \\
repo connect s3 --bucket corso-test repo connect s3 --bucket corso-test`
``` }</CodeBlock>
</TabItem> </TabItem>
</Tabs> </Tabs>