Versity Gateway
Versity Gateway
Get Started with Apps!
Get Started with Apps!
App Version: v1.0.13
(Changelog)
Keywords: storage, object-storage, S3, versity
Train: Community
Home Page: https://github.com/versity/versitygw
Keywords: storage, object-storage, S3, versity
Train: Community
Home Page: https://github.com/versity/versitygw
Versity Gateway Details
Added: 2025-05-07
Last Updated: 2025-05-20
Added: 2025-05-07
Last Updated: 2025-05-20
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.
Run as Context- Versity Gateway runs as any non-root user.
Group: 568 / versity
User: 568 / versity
×
![Full Screenshot]()
App Metadata (Raw File)
{
"1.0.0": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/versitygw/1.0.0",
"last_update": "2025-05-20 13:10:10",
"required_features": [],
"human_version": "v1.0.13_1.0.0",
"version": "1.0.0",
"app_metadata": {
"app_version": "v1.0.13",
"capabilities": [],
"categories": [
"storage"
],
"changelog_url": "https://github.com/versity/versitygw/releases",
"date_added": "2025-05-07",
"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.",
"home": "https://github.com/versity/versitygw",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/versitygw/icons/icon.svg",
"keywords": [
"storage",
"object-storage",
"S3",
"versity"
],
"lib_version": "2.1.23",
"lib_version_hash": "59e54688cf43e573fe96d939c5a9e9a7ae74d5441ff00daa81fe9aa8d52249b9",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "versitygw",
"run_as_context": [
{
"description": "Versity Gateway runs as any non-root user.",
"gid": 568,
"group_name": "versity",
"uid": 568,
"user_name": "versity"
}
],
"screenshots": [],
"sources": [
"https://github.com/versity/versitygw"
],
"title": "Versity Gateway",
"train": "community",
"version": "1.0.0"
},
"schema": {
"groups": [
{
"name": "Versity Gateway Configuration",
"description": "Configure Versity Gateway"
},
{
"name": "User and Group Configuration",
"description": "Configure User and Group for Versity Gateway"
},
{
"name": "Network Configuration",
"description": "Configure Network for Versity Gateway"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Versity Gateway"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Versity Gateway"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Versity Gateway"
}
],
"questions": [
{
"variable": "TZ",
"group": "Versity Gateway Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "versity",
"label": "",
"group": "Versity Gateway Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "root_user_access_key",
"label": "Root User Access Key",
"description": "The access key for the root account.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "root_user_secret_access_key",
"label": "Root User Secret Access Key",
"description": "The secret access key for the root account.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for Versity Gateway.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "env",
"label": "Environment Variable",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
},
{
"variable": "additional_global_flags",
"label": "Additional Global Flags",
"description": "Additional global command-line flags for Versity Gateway.</br>\nIf you are unsure, leave this blank.\n",
"schema": {
"type": "list",
"items": [
{
"variable": "item",
"label": "",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "flag",
"label": "Flag",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"default": ""
}
}
]
}
}
]
}
},
{
"variable": "additional_posix_flags",
"label": "Additional POSIX Flags",
"description": "Additional command-line flags for the POSIX backend of Versity Gateway.</br>\nIf you are unsure, leave this blank.\n",
"schema": {
"type": "list",
"items": [
{
"variable": "item",
"label": "",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "flag",
"label": "Flag",
"schema": {
"type": "string",
"default": "",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"default": ""
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "run_as",
"label": "",
"group": "User and Group Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "user",
"label": "User ID",
"description": "The user id that Versity Gateway files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
},
{
"variable": "group",
"label": "Group ID",
"description": "The group id that Versity Gateway files will be owned by.",
"schema": {
"type": "int",
"min": 568,
"default": 568,
"required": true
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "api_port",
"label": "API Port",
"description": "The port for Versity Gateway S3 API",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "bind_mode",
"label": "Port Bind Mode",
"description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
"schema": {
"type": "string",
"default": "published",
"enum": [
{
"value": "published",
"description": "Publish port on the host for external access"
},
{
"value": "exposed",
"description": "Expose port for inter-container communication"
},
{
"value": "",
"description": "None"
}
]
}
},
{
"variable": "port_number",
"label": "Port Number",
"schema": {
"type": "int",
"default": 30157,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "host_ips",
"label": "Host IPs",
"description": "IPs on the host to bind this port",
"schema": {
"type": "list",
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"default": [],
"items": [
{
"variable": "host_ip",
"label": "Host IP",
"schema": {
"type": "string",
"required": true,
"$ref": [
"definitions/node_bind_ip"
]
}
}
]
}
}
]
}
},
{
"variable": "admin_port",
"label": "Admin Port",
"description": "The port for Versity Gateway admin API (defaults to the same as the API port)",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "bind_mode",
"label": "Port Bind Mode",
"description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
"schema": {
"type": "string",
"default": "",
"enum": [
{
"value": "published",
"description": "Publish port on the host for external access"
},
{
"value": "exposed",
"description": "Expose port for inter-container communication"
},
{
"value": "",
"description": "None"
}
]
}
},
{
"variable": "port_number",
"label": "Port Number",
"schema": {
"type": "int",
"default": 30158,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "host_ips",
"label": "Host IPs",
"description": "IPs on the host to bind this port",
"schema": {
"type": "list",
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"default": [],
"items": [
{
"variable": "host_ip",
"label": "Host IP",
"schema": {
"type": "string",
"required": true,
"$ref": [
"definitions/node_bind_ip"
]
}
}
]
}
}
]
}
},
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network. It's recommended to keep this disabled.\n",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "certificate_id",
"label": "Certificate",
"description": "The certificate to use for Versity Gateway.",
"schema": {
"type": "int",
"null": true,
"$ref": [
"definitions/certificate"
]
}
},
{
"variable": "admin_certificate_id",
"label": "Admin Certificate",
"description": "The certificate to use for the admin server of Versity Gateway.</br>\nWill be ignored if Admin Port's bind mode is None.\n",
"schema": {
"type": "int",
"null": true,
"$ref": [
"definitions/certificate"
]
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "buckets",
"label": "Versity Gateway Bucket Storage",
"description": "The path to store S3 bucket data",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"hidden": true,
"default": "buckets"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
}
]
}
},
{
"variable": "additional_storage",
"label": "Additional Storage",
"description": "Additional storage for Versity Gateway.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storageEntry",
"label": "Storage Entry",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"immutable": true,
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
},
{
"value": "cifs",
"description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
}
]
}
},
{
"variable": "read_only",
"label": "Read Only",
"description": "Mount the volume as read only.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "mount_path",
"label": "Mount Path",
"description": "The path inside the container to mount the storage.",
"schema": {
"type": "path",
"required": true
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"default": "storage_entry"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
}
]
}
},
{
"variable": "cifs_config",
"label": "SMB Configuration",
"description": "The configuration for the SMB dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"cifs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "username",
"label": "Username",
"description": "The username to use for the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "password",
"label": "Password",
"description": "The password to use for the SMB share.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "domain",
"label": "Domain",
"description": "The domain to use for the SMB share.",
"schema": {
"type": "string"
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "labels",
"label": "",
"group": "Labels Configuration",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "label",
"label": "Label",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "key",
"label": "Key",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "Containers where the label should be applied",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "versity",
"description": "versity"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "resources",
"label": "",
"group": "Resources Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "limits",
"label": "Limits",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "cpus",
"label": "CPUs",
"description": "CPUs limit for Versity Gateway.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Versity Gateway.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Versity S3 Gateway</h1> <p>The <a href=\"https://github.com/versity/versitygw\">Versity S3 Gateway</a> is a simple to use tool for seamless inline translation between AWS S3 object commands and storage systems.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "v1.0.13",
"capabilities": [],
"categories": [
"storage"
],
"changelog_url": "https://github.com/versity/versitygw/releases",
"date_added": "2025-05-07",
"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.",
"home": "https://github.com/versity/versitygw",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/versitygw/icons/icon.svg",
"keywords": [
"storage",
"object-storage",
"S3",
"versity"
],
"lib_version": "2.1.23",
"lib_version_hash": "59e54688cf43e573fe96d939c5a9e9a7ae74d5441ff00daa81fe9aa8d52249b9",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "versitygw",
"run_as_context": [
{
"description": "Versity Gateway runs as any non-root user.",
"gid": 568,
"group_name": "versity",
"uid": 568,
"user_name": "versity"
}
],
"screenshots": [],
"sources": [
"https://github.com/versity/versitygw"
],
"title": "Versity Gateway",
"train": "community",
"version": "1.0.0"
}
}
}Support, maintenance, and documentation for applications within the Community catalog is handled by the TrueNAS community. The TrueNAS Applications Portal hosts but does not validate or maintain any linked resources associated with this app.
There currently aren’t any resources available for this application!
Please help the TrueNAS community add resources here or discuss this application in the TrueNAS Community forum.