diff --git a/docs/docs/configuration/repos.md b/docs/docs/configuration/repos.md index 341ea79b1..ae24466fd 100644 --- a/docs/docs/configuration/repos.md +++ b/docs/docs/configuration/repos.md @@ -55,7 +55,7 @@ Before setting you your Corso S3 repository, the following prerequisites must be ### Credential setup {#s3-creds-setup} -Corso supports the credential options offered by the Go SDK. For Full details, see the *Specifying Credentials* +Corso supports the credential options offered by the AWS Go SDK. For Full details, see the *Specifying Credentials* section of the [official documentation](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html). * **Environment variables** - set and export `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. If using temporary diff --git a/docs/docs/install.md b/docs/docs/install.md deleted file mode 100644 index 007223d93..000000000 --- a/docs/docs/install.md +++ /dev/null @@ -1,83 +0,0 @@ -# Installation - -Corso releases are available using the following options: - -import TOCInline from '@theme/TOCInline'; - -
- -:::note - -To maximize portability across platforms, Corso is available as a container image. In the future, -releases may also be available as operating system specific pre-built binaries. - -In the meantime, if you want to run Corso as a binary, refer to the -[instructions on how to build from source](developers/build). - -::: - -## Docker image - -To use Corso as a Docker image, you need to have [Docker installed](https://docs.docker.com/engine/install/) -on your machine. - -### Docker command - -To run the Corso container, it's recommended that you: - -* Export [Corso key configuration environment variables](cli/corso_env) and add their names to an -[environment variables file](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) -* Map a local directory to `/app/corso`. Corso will look for or create the `corso.toml` config file there. This will preserve - configuration across container runs. Corso will use the directory for logs, if enabled. - -To create the environment variables file, you can run the following. - -```bash -# create an env vars file -$ cat < +``` + +## Environment Variables + +Three distinct pieces of configuration are required by Corso: + +* S3 object storage configuration to store backups. See [AWS Credentials Setup](/configuration/repos##s3-creds-setup) for +alternate ways to pass AWS credentials. + * `AWS_ACCESS_KEY_ID`: + * `AWS_SECRET_ACCESS_KEY`: + * (Optional) `AWS_SESSION_TOKEN`: + +* Microsoft 365 Configuration + * `AZURE_TENANT_ID`: + * `AZURE_CLIENT_ID`: + * `AZURE_CLIENT_SECRET`: + +* Corso Security Passphrase + * `CORSO_PASSPHRASE`: + +For ease of use with Docker, we recommend adding the names of the required environment variables (but not their +values!) to a [Docker environment variables file](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file). +To create the environment variables file, you can run the following command: + +```bash +# create an env vars file +$ cat <