website logo
Create accountLogin
Home
DCS
Node
Resources
Help center
Navigate through spaces
Home
DCS
Node
Resources
Help center
⌘K
Storj DCS
Get Started
AWS CLI and Hosted Gateway MT
AWS SDK and Hosted Gateway MT
Uplink CLI
Satellite Admin Console
Object Browser
Downloads
Download Uplink CLI
Download Self-hosted S3 Compatible Gateway
Download Storj Client Libraries
SDKs & Reference
Tutorial
How-to Guides
Concepts
Support
Support Overview
FAQ
Community Forum
Status Page
Help Desk
Billing, Payment & Accounts
Resources
Moved Documents
Docs powered by archbee 
38min

share

Shares restricted access to objects

Usage

Windows
Linux
MacOS
|

An access generated using uplink share with no arguments creates an access to your entire project with read permissions.

Flags

Flag
Description
--access string
the serialized access, or name of the access to use
--auth-service string
url for shared auth service, https://auth.storjshare.io by default
--base-url string
the base url for link sharing, https://link.storjshare.io by default
--disallow-deletes
if true, disallow deletes
--disallow-lists
if true, disallow lists
--disallow-reads
if true, disallow reads
--disallow-writes
if true, disallow writes
--dns string
specify your custom hostname. if set, returns dns settings for web hosting. implies --register and --public
--export-to string
path to export the shared access to
--help, -h
help for share
--not-after
disallow access after this time (e.g. '+2h', '2020-01-02T15:01:01-01:00')
--not-before
disallow access before this time (e.g. '+2h', '2020-01-02T15:01:01-01:00')
--public
if true, the access will be public. --dnsand --urloverride this
--readonly
implies --disallow-writes and --disallow-deletes
--register
if true, creates and registers access grant
--url
if true, returns a url for the shared path. implies --register and --public
--writeonly
implies --disallow-reads and --disallow-lists

Examples

Share a single object

Windows
Linux
MacOS
|

Notice that by default, only download (read) and list operations are allowed.

Terminal
|

Share a bucket with all permissions

Windows
Linux
MacOS
|

As the --readonly flag is set to false, uploads and deletes are allowed.

Terminal
|

Register with Gateway MT

Generate credentials to use with our S3 multitenant gateway: Quickstart - AWS CLI and Hosted Gateway MT

Windows
Linux
MacOS
|

Notice the endpoint generated for Gateway MT gateway.storjshare.io corresponds to the auth service used auth.storjshare.io.

Terminal
|

Link Sharing

You can also generate a URL to share your projects/buckets/objects

Windows
Linux
MacOS
|

Note that specifying --base-url is optional, but the --not-after is mandatory. If you do not want to specify date or offset - you can specify --not-after=none.

See flags of share command for details.

Terminal
|

Also note that the URL uses the same Gateway MT access key, so if you have that already, you don't necessarily need to run this command to generate a shareable link.

https://link.storjshare.io/s/<access key>/<object path>

To download content directly, use /raw/ in Linkshare URL ex: https://link.storjshare.io/raw/ju34skavohcqezr6vlfgshg5nmjq/dwebdemo/isthataquestion.mp4

To view the object location map, use /s/ in Linkshare URL ex: https://link.storjshare.io/s/ju34skavohcqezr6vlfgshg5nmjq/dwebdemo/isthataquestion.mp4

Webhosting

For more detail, visit the documentation on hosting a static website with the Uplink CLI.

While you may share individual objects with the above linksharing instructions, you must share a bucket or object prefix for webhosting. Your web address will render the index.html file.

Windows
Linux
MacOS
|
Terminal
|

Use the generated DNS info to connect your domain name to your shared objects.

Note you can use any hostname in place of www.mysite.com in the example. The base-url is also optional.

Updated 21 Nov 2022
Did this page help you?
Yes
No
UP NEXT
Self-hosted S3 Compatible Gateway
Docs powered by archbee 
TABLE OF CONTENTS
Usage
Flags
Examples
Share a single object
Share a bucket with all permissions
Register with Gateway MT
Link Sharing
Webhosting