rustfs

Deploys RustFS object storage using the official Docker image.

Use it on boxctl

  1. On the dashboard, pick rustfs in the Template picker and click Boot box.
  2. The box boots, then runs rustfs/rustfs.sh on itself. The button reads Booting… until the script has finished.
  3. Open the box's Terminal and follow the guide below. The box's row keeps a link back to this page under the template's name.

The guide is shared with the onctl CLI, so it starts from an onctl up -a rustfs/rustfs.sh command. Booting a box with this template replaces that command; everything the guide runs on the VM itself applies as written.

Options

boxctl cannot pass options to a template yet, so each of these keeps its default.

OptionRequiredWhat it sets
RUSTFS_VERSIONNoImage tag (default: latest).
DATA_DIRNoDefault: /opt/rustfs/data.
LOG_DIRNoDefault: /opt/rustfs/logs.

RustFS on Docker

This template deploys RustFS using the official Docker image. It installs Docker when required, prepares data/log directories with the correct UID for the container (10001), and runs RustFS with ports 9000 (S3 API) and 9001 (console) exposed.

Usage

# Optional: set a specific version and custom data/log paths
export RUSTFS_VERSION=1.0.0-alpha.76
export DATA_DIR=/opt/rustfs/data
export LOG_DIR=/opt/rustfs/logs

# Run the installer
./rustfs.sh

The container is started with --restart unless-stopped. If an existing rustfs container is found it will be replaced so new configuration takes effect.

See the template's source for exactly what it runs.