Linux Install
https://github.com/versity/versitygw/releases/latest
Choose the appropriate package for your distro and architecture. There are release packages for RedHat and Debian based distros, and binary tarball packages that can be used with any other distros.
You can find the architecture of your linux system with the uname -m command. For x86_64 arch, use the amd64 rpm/deb or x86_64 tar.gz. For arm64, use the arm64 rpm/deb/tar release.
- Download the
versitygw_<version>_linux_<amd64/arm64>.rpmfrom the release page choosing the appropriate one for your architecture. - Install the rpm with
sudo dnf install ./versitygw_*.rpm
- Download the
versitygw_<version>_linux_<amd64/arm64>.debfrom the release page choosing the appropriate one for your architecture. - Install the deb with
sudo dpkg -i ./versitygw_*.deb
- Download the
versitygw_<version>_linux_<x86_64/arm64>.tar.gzfrom the release page choosing the appropriate one for your architecture. - Extract files from tar with
tar -xzf versitygw_*.tar.gz
The package installations will install the versitygw binary as well as the systemd service files and example configuration files. The configuration files go below the directory /etc/versitygw.d. The packages install two example configs: /etc/versitygw.d/example.conf for an S3 gateway service, and /etc/versitygw.d/example-iam.conf for the standalone IAM service (VGW_BACKEND=iam).
Copy the example config file to /etc/versitygw.d/ naming it to a unique service name. For example, if the service name is "mygateway", then the file should be named /etc/versitygw.d/mygateway.conf. Edit the config file based on desired options for the gateway service. The systemd template file /lib/systemd/system/versitygw@.service will automatically load the configuration file for the service by name. Replace the references to "mygateway" below with the appropriate name for the gateway based on the config file name you chose above.
To start the gateway, use the following command:
systemctl start versitygw@mygateway
To enable the gateway to start on boot, use the following command:
systemctl enable versitygw@mygateway
To stop the gateway, use the following command:
systemctl stop versitygw@mygateway
To troubleshoot failures starting the service, journalctl can give more detailed output:
journalctl -u versitygw@mygateway.service
There can be multiple gateway services running on the same host. Each gateway service must have a unique service name with a unique configuration file in /etc/versitygw.d/. They must also listen on different ports and/or interfaces using the VGW_PORT option.
The /etc/versitygw.d/example.conf describes all options (also documented in Global-Options). The default values are specified in the options that are commented out. A minimal config for a posix backend would be:
VGW_BACKEND=posix
VGW_BACKEND_ARG=<gateway_root_path>
ROOT_ACCESS_KEY_ID=<access_key>
ROOT_SECRET_ACCESS_KEY=<secret_key>
The same versitygw@<name> template also runs the standalone IAM service; start from /etc/versitygw.d/example-iam.conf. A minimal IAM config is:
VGW_BACKEND=iam
VGW_IAM_DIR=<iam_state_dir>
ROOT_ACCESS_KEY_ID=<access_key>
ROOT_SECRET_ACCESS_KEY=<secret_key>
There is no VGW_BACKEND_ARG — the iam backend takes no positional argument. Create VGW_IAM_DIR before the first start; the service will not create it. An IAM service and a gateway on the same host must not share a port, and both default VGW_PORT to :7070. See Standalone-IAM-Setup for the full option reference.
The RPM and DEB packages install shell completion scripts automatically. For manual installations, completion scripts for bash, zsh, and fish are included in the release tarball under the extra/ directory.
Source the completion script from your shell profile or drop it in the system completions directory:
# User only
source /path/to/extra/versitygw.sh
# System-wide (RPM/DEB installs place it here automatically)
sudo cp extra/versitygw.sh /etc/bash_completion.d/versitygwCopy the zsh completion file to a directory in your fpath, then enable completion in ~/.zshrc:
sudo cp extra/versitygw.zsh /usr/share/zsh/site-functions/_versitygwAdd to ~/.zshrc if not already present:
fpath=(/usr/share/zsh/site-functions $fpath)
autoload -Uz compinit && compinitCopy the fish completion file to the fish completions directory:
cp extra/versitygw.fish ~/.config/fish/completions/versitygw.fish
