# Versity Gateway

Versity Gateway is a self-hosted backup app. The Versity Gateway serves as a bridge between file based, POSIX, storage systems and applications that rely on S3 object interfaces. It is open source and self-hosted, installable on Docker Hub, Proxmox, Unraid and TrueNAS.

Canonical page: https://ourlocalhost.com/app/3739/versity-gateway

## Description

The Versity Gateway serves as a bridge between file based, POSIX, storage systems and applications that rely on S3 object interfaces. It enables applications to interact with file storage using familiar S3 operations like put and get, allowing for easy integration and compatibility.

## Platform availability

Available on 3 of 9 platforms: Unraid, TrueNAS, Proxmox.

## Health score

73/100 (Good), based on 5 of 5 factors.
- Maintained: 100 (last commit 1 day ago)
- Popular: 70 (3,065 GitHub stars)
- Easy to install: 55 (3 install platforms, install notes, Docker image)
- Light to run: 20 (16 GB minimum RAM, runs on ARM)
- Security check: 82 (no serious findings, 3 minor, CI, tests)

## Links

- Official website: https://www.versity.com/products/versitygw/
- Docker Hub: https://hub.docker.com/r/versity/versitygw
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=versitygw
- Unraid: https://ca.unraid.net/apps/versitygw-1upkesl09vikj5?q=VersityGW
- TrueNAS: https://apps.truenas.com/catalog/versitygw/
- GitHub: https://github.com/versity/versitygw
- Documentation: https://www.versity.com/resource-type/documentation/

## Common questions

### Why do some S3 clients fail with Versity Gateway if the client is left on default settings?

Versity Gateway uses path style addressing by default, while many clients default to virtual host style. Configure the client to use path style requests, or enable virtual host style with the --virtual-domain flag.

### How should self-hosters handle a self-signed TLS certificate?

If you use a self-signed certificate, configure the S3 client to trust that certificate. This avoids TLS certificate errors during requests.

### How can a bucket be served as a static website?

Enable a separate website endpoint and use --website-domain for virtual-host style routing, where subdomains map to bucket names. If you omit --website-domain, catch-all mode makes the full hostname the bucket name, so buckets should be named as fully qualified domain names.

### Where should POSIX sidecar metadata be stored?

If you enable the POSIX sidecar option, put its directory in a location that is accessible and distinct from the folder holding object data. Keeping metadata separate helps avoid missing or incorrect object details.

### What data directories need to be persistent in a command-line quickstart?

Set the IAM, versioning, and gateway data directories to a safe, persistent location. The quickstart example uses /tmp, which may be cleared after reboot.

### What keys must be changed in a Helm deployment?

Replace the sample access and secret keys with your own. Those keys are used by S3 clients and the Web UI to authenticate.

---
Source: Our Local Host (https://ourlocalhost.com/app/3739/versity-gateway), the self-hosted and open-source app directory.