245bb6e73e
* Bounce package.json verison to 0.1.0 * Docs cleanup driven by Vale * Clarifying language * Clarify that permissions bit is important * End of line white space linter warnings * Straighten what seemed like awkward constructs in prerequisites * Sync up with `docs/intro.md` Co-authored-by: Georgi Matev <gmatev@alcion.ai>
84 lines
2.5 KiB
Markdown
84 lines
2.5 KiB
Markdown
# Installation
|
|
|
|
Corso releases are available using the following options:
|
|
|
|
import TOCInline from '@theme/TOCInline';
|
|
|
|
<TOCInline toc={toc} maxHeadingLevel={2}/><br/>
|
|
|
|
:::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 <<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](/configuration/repos##s3-creds-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.
|
|
|
|
```bash
|
|
$ 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](https://docs.microsoft.com/en-us/virtualization/windowscontainers/quick-start/quick-start-windows-10-linux)
|
|
|
|
:::
|
|
|
|
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
|