corso/docs/docs/install.md

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.

:::

Docker image

To use Corso as a Docker image, you need to have Docker installed on your machine.

Docker command

To run the Corso container, it's recommended that you:

• Export Corso key configuration environment variables and add their names to an environment variables 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.

# create an env vars file
$ cat <<EOF ~/.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

:::note

Depending on your preferred method for passing AWS credentials, you may need to adapt the AWS_ variables in the file. See AWS Credentials Setup for more details.

:::

The following command will list the Corso Exchange backups. You can adapt the folder mappings, container tag, and the command as needed.

$ docker run --env-file ~/.corso/corso.env \
    -v ~/.corso/corso:/app/corso \ 
    corso/corso backup list exchange 

Available variants

The Corso image is available on DockerHub for the following architectures:

• Linux and Windows x86-64 - amd64
• ARM 64-bit - arm64

:::tip

For Windows, you can run the amd64 container in Linux Mode

:::

The following tags are available:

• :x.y.z - A specific release build
• :pre-release - The most recent pre-release if newer that the latest stable release
• :nightly - The most recent unstable developer build
• :SHA - A specific build