Quick Start

Install and start RustFS

Run the official installation script:

curl -O https://rustfs.com/install_rustfs.sh && bash install_rustfs.sh

The script installs the binary to /usr/local/bin/rustfs, registers a rustfs systemd service, and starts it. By default it stores data in /data/rustfs0 and listens on port 9000 (S3 API) and 9001 (Console); the data path and ports can be adjusted during installation. On success it prints a summary like:

RustFS has been installed and started successfully!
Service port: 9000,  Console port: 9001,  Data directory: /data/rustfs0

[SECURITY WARNING] Please change the default value for RUSTFS_ACCESS_KEY/RUSTFS_SECRET_KEY immediately ...
  Config file: /etc/default/rustfs

Set your credentials

The generated config file ships placeholder credentials. Set your own access key and secret key, then restart the service:

RUSTFS_ACCESS_KEY=<your-access-key>
RUSTFS_SECRET_KEY=<your-secret-key>   ; e.g. output of: openssl rand -base64 24

Use an uppercase alphanumeric access key. Do not use unmodified Base64 output for RUSTFS_ACCESS_KEY, because Base64 can contain /, which conflicts with the AWS Signature Version 4 credential scope. See Credential Management for details.

sudo systemctl restart rustfs
sudo systemctl status rustfs --no-pager   # should report: active (running)

Log in to the Console

Open http://<server-ip>:9001 in your browser and sign in with the access key and secret key from step 2.

Create a bucket and upload a file

1. In the Console home page, select Create Bucket, name it (for example my-bucket), and confirm.
2. Open the bucket and use the upload action to add any local file.
3. Click the uploaded object to view its details — you have a working object store.

Prefer the command line? Configure rc, then perform the same operations:

rc alias set rustfs http://<server-ip>:9000 <your-access-key> <your-secret-key>
rc bucket create rustfs/my-bucket
rc object copy /path/to/hello.txt rustfs/my-bucket/hello.txt
rc object list rustfs/my-bucket

✓ Bucket 'rustfs/my-bucket' created successfully.
/path/to/hello.txt -> rustfs/my-bucket/hello.txt