HDD-Housing e.U.

Install VersityGW: S3-compatible storage on ZFS

Note: Replace poolname in all commands with your customer ID.

VersityGW is an open-source S3 gateway. With the POSIX backend, it stores every object as a plain file on your ZFS pool. This makes it an ideal S3 backend for backups – and a lightweight alternative to MinIO.

Install the latest version

v=$(curl -s https://api.github.com/repos/versity/versitygw/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
wget "https://github.com/versity/versitygw/releases/download/${v}/versitygw_${v:1}_linux_amd64.deb"
wget "https://github.com/versity/versitygw/releases/download/${v}/checksums.txt"
sha256sum -c checksums.txt --ignore-missing && dpkg -i ./versitygw_${v:1}_linux_amd64.deb

Create user and directories

groupadd -g 1100 versitygw
useradd -m -s /bin/bash -d /poolname/versitygw/home -u 1100 -g 1100 versitygw
echo "versitygw:$(openssl rand -base64 100 | tr -d '=+/\n\r' | cut -c 1-70)" | chpasswd
mkdir -p /poolname/versitygw/buckets /poolname/versitygw/accounts
chown -R versitygw:versitygw /poolname/versitygw

Configuration

nano /etc/versitygw.d/versitygw.conf

Paste this content:

VGW_BACKEND=posix

# Top-level directory of the gateway. Every subdirectory is a bucket,
# everything below a bucket directory is an object.
# Example: bucket "mybucket", object "a/b/c/myobject"
# -> /poolname/versitygw/buckets/mybucket/a/b/c/myobject
VGW_BACKEND_ARG=/poolname/versitygw/buckets

ROOT_ACCESS_KEY_ID=
ROOT_SECRET_ACCESS_KEY=

VGW_PORT=:7070

VGW_ADMIN_PORT=:17070

VGW_IAM_DIR=/poolname/versitygw/accounts

Set your own admin credentials for ROOT_ACCESS_KEY_ID and ROOT_SECRET_ACCESS_KEY, e.g. generated with openssl rand -hex 20.

Start the service

systemctl enable --now versitygw@versitygw
systemctl status versitygw@versitygw

The instance name after @ matches the config file /etc/versitygw.d/versitygw.conf.

Manage users and buckets

access=admin_access_key_id
secret=admin_secret_access_key
port=17070

# Create user
versitygw admin -a $access -s $secret -er http://127.0.0.1:$port create-user -a user_access_key_id -s user_secret_access_key -r user_role -ui user_userID -gi user_groupID
# user_role: 'user', 'admin' or 'userplus' (userplus can create buckets, user cannot)
# -ui and -gi are optional

# Delete user
versitygw admin -a $access -s $secret -er http://127.0.0.1:$port delete-user -a user_access_key_id

# List users
versitygw admin -a $access -s $secret -er http://127.0.0.1:$port list-users

# Change bucket owner
versitygw admin -a $access -s $secret -er http://127.0.0.1:$port change-bucket-owner -b bucket_name -o new_owner_access_key_id

# List buckets and owners
versitygw admin -a $access -s $secret -er http://127.0.0.1:$port list-buckets

Update script

This script installs the latest release after checking its checksum:

#!/bin/bash
v=$(curl -s https://api.github.com/repos/versity/versitygw/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
wget "https://github.com/versity/versitygw/releases/download/${v}/versitygw_${v:1}_linux_amd64.deb"
wget "https://github.com/versity/versitygw/releases/download/${v}/checksums.txt"

sha256sum -c checksums.txt --ignore-missing
if [ $? == 0 ]
then
        rm checksums.txt
        read -p "Do you want to install $v? (y/N) " confirm
        [[ "$confirm" != "y" ]] && exit 0
        dpkg -i ./versitygw_${v:1}_linux_amd64.deb
        systemctl daemon-reload
        systemctl restart versitygw@*
        sleep 3
        systemctl status versitygw@*
fi