Storage Gateway
Storage Gateway lets you:
- Connect your storage to one or more MASV Portals and have files automatically delivered to it.
- Use the MASV Web App with Team members to access specific file locations on connected storage without requiring them to have direct or remote access to the storage.
Setup guide
If you are looking for an end-to-end setup guide, see How to integrate storage devices with MASV.
Prerequisites
Setting up a Storage Gateway requires MASV Agent to be installed on the server that provides storage.
To install the MASV Agent, choose one of the following:
- For native installations on Linux, follow our Native setup guide.
- Install and run MASV with Docker, follow our Docker setup guide.
Tip
If you're running the MASV Agent with Docker, you must execute masv
or curl
commands within the container. See our Docker setup guide for more details.
Managing connections
Add a connection
masv gateway add \
--id <your-key> \
--secret <your-secret> \
--name <your-connection-name> \
--root-path <your-shared-folder> \
--permissions <your-permissions>
curl -X POST -H "Content-Type: application/json" http://localhost:8080/api/v1/storage_gateway/register -d '{
"id": "<your-key>",
"secret": "<your-secret>",
"name": <your-connection-name>,
"root_path": "<your-shared-folder>",
"permissions": "<your-permissions>",
}'
Parameters
Name | Type | Required | Description |
---|---|---|---|
id |
String | Yes | ID of the existing Storage Device Integration |
name |
String | Yes | Connection name—use something descriptive and easy to recognize |
permissions |
String | Yes | Determines the file permissions afforded to this connection. Valid values: r , w |
root-path |
String | Yes | This folder and everything within it will become remotely accessible. Must be an absolute path. |
secret |
String | Yes | Unique secret key required to register this connection with the MASV API |
Name | Type | Required | Description |
---|---|---|---|
id |
String | Yes | ID of the existing Storage Device Integration |
name |
String | Yes | Connection name—use something descriptive and easy to recognize |
permissions |
String | Yes | Determines the file permissions afforded to this connection. Valid values: r , w |
root_path |
String | Yes | This folder and everything within it will become remotely accessible. Must be an absolute path. |
secret |
String | Yes | Unique secret key required to register this connection with the MASV API |
List connections
You can list your registered connections with:
masv gateway ls
curl -X GET http://localhost:8080/api/v1/storage_gateway/list
Remove a connection
You can remove a connection from the MASV Agent using the following:
masv gateway rm CONNECTION_ID
curl -X POST -H "Content-Type: application/json" http://localhost:8080/api/v1/storage_gateway/unregister -d '{
"id":"CONNECTION_ID",
}'
Tip
Removing a connection disconnects it from the MASV Agent—it does not delete the Storage Device Integration from your MASV account.