Skip to main content

Installation

The easiest way to try out Chorus is the standalone installation. The standalone installation requires no extra tools and has zero dependencies. The standalone version of Chorus does not persist any data between restarts, so it can be used only for education. For production-like environments, do not use the standalone installation, but instead use Helm chart or Docker.

chorus-components.png

Helm Chart​

See the Helm chart README for installation instructions, configuration examples, and available options.

Quick install:

helm install <release-name> oci://harbor.clyso.com/chorus/chorus -f values.yaml

For more information, see Configuration section.

Docker compose​

See the docker-compose example on GitHub.

Management CLI​

Chorus provides a CLI called chorctl as an alternative to the web UI.

Installation steps:

  1. Download a suitable chorctl_* binary from the latest release page.
  2. Unpack the binary and add it to the system PATH.

Alternatively, use homebrew (for MacOS and Linux only):

brew install clyso/tap/chorctl

Usage:

  1. By default, chorctl uses localhost:9670 to call the management GRPC API. To override this default, use environment variables: 
    export CHORUS_ADDRESS=<grpc api ip or domain>:<port>
    Or -a or --address flag: 
    chorctl -a '<grpc api ip or domain>:<port>'
  2. Print help to see available commands and flags: 
    chorctl help
  3. See the replication dashboard: 
    chorctl dash
  4. Manage replications per user or per bucket with the chorctl repl command 
    chorctl repl -h

Chorus - Standalone Version​

The standalone version does not persist data, so it cannot be used for production.

Chorus provides a standalone version that is suitable as a local development playground. The standalone version is a single binary that contains all Chorus components, along with embedded in-memory S3 storages for test purposes:

  • Chorus proxy running on port 9669.
  • Management web UI on port 9672.
  • Management GRPC API on port 9670.
  • Management REST API on port 9671.
  • 2 Fake s3 storage on ports 9680 [MAIN] and 9681.

Chorus Installation​

  1. Download a suitable standalone_* binary from the latest release page.
  2. Unpack the binary and add it to the system PATH.
  3. Run chorus -h or chorus -help to print help. Usage: If no flags and arguments are passed to the command, then chorus will start with embedded fake S3 storages. Modify Chorus config to run it against custom storages:

Modifying Chorus Configuration​

  1. Print the current fake configuration into a file by running the chorus print-config > my-conf.yaml command
  2. Open my-conf.yaml with a text editor end replace s3 URLs and credentials. 1. Run Chorus with the new configuration file by running the command chorus -config ./my-config.yaml.

Alternate Method of Modifying the Chorus Configuration​

  1. Alternatively, put the configuration file in the default Chorus configuration directory, $HOME/.config/chorus/config.yaml: 
     mkdir -p ~/.config/chorus && mv ./my-config.yaml ~/.config/chorus/config.yaml

Chorus will now use the config by default.