diff --git a/docs/blog/2022-11-16-corso-announcement-free-backup-for-microsoft-365.md b/docs/blog/2022-11-16-corso-announcement-free-backup-for-microsoft-365.md index 73bcca8b5..09f3e0dd3 100644 --- a/docs/blog/2022-11-16-corso-announcement-free-backup-for-microsoft-365.md +++ b/docs/blog/2022-11-16-corso-announcement-free-backup-for-microsoft-365.md @@ -76,7 +76,7 @@ costs, as well. ## Interested in Trying Corso? Corso, currently in alpha, provides a CLI-based tool for backups of your M365 data. -[Follow the quickstart guide](../docs/quickstart) to start protecting your business-critical M365 data in +[Follow the quickstart guide](../../docs/quickstart) to start protecting your business-critical M365 data in just a few minutes. Because Corso is currently in alpha, it should NOT be used in production. Corso supports Microsoft 365 Exchange and OneDrive, with SharePoint and Teams support in active development. Coverage diff --git a/docs/docs/developers/testing.md b/docs/docs/developers/testing.md index 2e7ee8bd3..83593daa8 100644 --- a/docs/docs/developers/testing.md +++ b/docs/docs/developers/testing.md @@ -30,7 +30,7 @@ - Set M365 Credentials environment variables - > You can find more information on how to get these values in our [M365 docs](../setup/m365_access). + > You can find more information on how to get these values in our [M365 docs](../../setup/m365_access/). ```bash export AZURE_CLIENT_ID= diff --git a/docs/docs/intro.md b/docs/docs/intro.md index 823394737..55466f4ea 100644 --- a/docs/docs/intro.md +++ b/docs/docs/intro.md @@ -12,6 +12,6 @@ beyond M365, will expand based on the interest and needs of the community. ## Getting started -You can follow the [Quick Start](quickstart) guide for an end-to-end Corso walk through. Alternatively, follow -the instructions in the [Corso Setup](setup/concepts) section to dive into the details on how to configure and +You can follow the [Quick Start](../quickstart) guide for an end-to-end Corso walk through. Alternatively, follow +the instructions in the [Corso Setup](../setup/concepts) section to dive into the details on how to configure and run Corso. diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index 53cefa1af..d3722a967 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -21,13 +21,13 @@ pull the image. ## Connect to Microsoft 365 Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time operation. Follow the instructions -[here](setup/m365_access) to obtain the necessary credentials and then make them available to Corso. +[here](../setup/m365_access) to obtain the necessary credentials and then make them available to Corso. ```powershell - $Env:AZURE_CLIENT_ID = "" + $Env:AZURE_CLIENT_ID = "" $Env:AZURE_TENANT_ID = "" $Env:AZURE_CLIENT_SECRET = "" ``` @@ -36,7 +36,7 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope ```bash - export AZURE_CLIENT_ID= + export AZURE_CLIENT_ID= export AZURE_TENANT_ID= export AZURE_CLIENT_SECRET= ``` @@ -45,7 +45,7 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope ```bash - export AZURE_CLIENT_ID= + export AZURE_CLIENT_ID= export AZURE_TENANT_ID= export AZURE_CLIENT_SECRET= ``` @@ -55,9 +55,9 @@ Obtaining credentials from Microsoft 365 to allow Corso to run is a one-time ope ## Create a Corso repository -To create a secure backup location for Corso, you will first need to [download Corso](setup/download). +To create a secure backup location for Corso, you will first need to [download Corso](../setup/download). Use the container or native executable to initialize the Corso repository using an -[encryption passphrase](setup/configuration#environment-variables) and a pre-created S3 bucket (Corso doesn't create +[encryption passphrase](../setup/configuration#environment-variables) and a pre-created S3 bucket (Corso doesn't create the bucket if it doesn't exist). 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. @@ -118,7 +118,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ## Create your first backup Corso can do much more, but you can start by creating a backup of your Exchange mailbox. If it has been a while since -you initialized the Corso repository, you might need to [connect to it again](setup/repos#connect-to-a-repository). +you initialized the Corso repository, you might need to [connect to it again](../setup/repos#connect-to-a-repository). @@ -202,7 +202,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ``` Next, select one of the available backups and list all backed up emails. See -[here](cli/corso_backup_details_exchange) for more advanced filtering options. +[here](../cli/corso_backup_details_exchange) for more advanced filtering options. @@ -285,5 +285,5 @@ A confirmation of the recovered email will be shown and the email will appear in The above tutorial only scratches the surface for Corso's capabilities. We encourage you to dig deeper by: -* Learning about [Corso concepts and setup](setup/concepts) -* Explore Corso backup and restore options for Exchange and Onedrive in the [Command Line Reference](cli/corso) +* Learning about [Corso concepts and setup](../setup/concepts) +* Explore Corso backup and restore options for Exchange and Onedrive in the [Command Line Reference](../cli/corso) diff --git a/docs/docs/setup/concepts.md b/docs/docs/setup/concepts.md index d8ff7f7e5..b9e8efae4 100644 --- a/docs/docs/setup/concepts.md +++ b/docs/docs/setup/concepts.md @@ -21,7 +21,7 @@ application to connect to your *M365 tenant* and transfer data during backup and ## Corso concepts {#corso-concepts} * **Repository** refers to the storage location where Corso securely and efficiently stores encrypted *backups* of your -*M365 Services* data. See [Repositories](repos) for more information. +*M365 Services* data. See [Repositories](../repos) for more information. * **Backup** is a copy of your *M365 Services* data to be used for restores in case of deletion, loss, or corruption of the original data. Corso performs backups incrementally, and each backup only captures data that has changed between backup iterations. diff --git a/docs/docs/setup/configuration.md b/docs/docs/setup/configuration.md index 15506e9ec..4a07d8f21 100644 --- a/docs/docs/setup/configuration.md +++ b/docs/docs/setup/configuration.md @@ -14,7 +14,7 @@ Two things are needed to configure Corso: Three distinct pieces of configuration are required by Corso: -* S3 object storage configuration to store backups. See [AWS Credentials Setup](repos#s3-creds-setup) for +* S3 object storage configuration to store backups. See [AWS Credentials Setup](../repos#s3-creds-setup) for alternate ways to pass AWS credentials. * `AWS_ACCESS_KEY_ID`: Access key for an IAM user or role for accessing an S3 bucket * `AWS_SECRET_ACCESS_KEY`: Secret key associated with the access key diff --git a/docs/docs/setup/m365_access.md b/docs/docs/setup/m365_access.md index 4ca8f656e..5e38835a4 100644 --- a/docs/docs/setup/m365_access.md +++ b/docs/docs/setup/m365_access.md @@ -7,8 +7,8 @@ description: "Connect to a Microsft 365 tenant" import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -To perform backup and restore operations, Corso requires access to your [M365 tenant](concepts#m365-concepts) -by creating an [Azure AD application](concepts#m365-concepts) with appropriate permissions. +To perform backup and restore operations, Corso requires access to your [M365 tenant](../concepts#m365-concepts) +by creating an [Azure AD application](../concepts#m365-concepts) with appropriate permissions. The following steps outline a simplified procedure for creating an Azure Ad application suitable for use with Corso. For more details, please refer to the diff --git a/docs/docs/setup/repos.md b/docs/docs/setup/repos.md index 634519b80..c95e47229 100644 --- a/docs/docs/setup/repos.md +++ b/docs/docs/setup/repos.md @@ -10,7 +10,7 @@ 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:
@@ -67,7 +67,7 @@ The two most commonly-used options are: ### Initialize repository Before first use, you need to initialize a Corso repository with `corso repo init s3`. See the command details -[here](../cli/corso_repo_init_s3). +[here](../../cli/corso_repo_init_s3). @@ -104,7 +104,7 @@ docker run --env-file $HOME/.corso/corso.env \\ ### Connect to a repository If a repository already exists, you can connect to it with `corso repo connect s3`. See the command details -[here](../cli/corso_repo_connect_s3). +[here](../../cli/corso_repo_connect_s3). @@ -149,4 +149,4 @@ need to use the following flag with the initial Corso `repo init` command: Corso also supports the use of object storage systems with no TLS certificate or with self-signed TLS certificates with the `--disable-tls` or `--disable-tls-verification` flags. -[These flags](../cli/corso_repo_init_s3) should only be used for testing. +[These flags](../../cli/corso_repo_init_s3) should only be used for testing. diff --git a/docs/docs/support/faq.md b/docs/docs/support/faq.md index b19fc9f97..4f5233a3a 100644 --- a/docs/docs/support/faq.md +++ b/docs/docs/support/faq.md @@ -16,7 +16,7 @@ metadata for basic information about installed versions and usage in a privacy-p generic description of most-commonly used backup operations and statistics on the duration and size of backups. No user data is stored or transmitted during this process. -Telemetry reporting can be turned off by using the `--no-stats` flag. See the [Command Line Reference](../cli/corso) +Telemetry reporting can be turned off by using the `--no-stats` flag. See the [Command Line Reference](../../cli/corso) section for more information. diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index 463e17f14..fa0593ae9 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -13,6 +13,7 @@ const config = { onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'throw', favicon: 'img/corso_logo.svg', + trailingSlash: true, // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these.