website logo
Create accountLogin
Home
DCS
Node
Resources
Help center
Navigate through spaces
⌘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 

share

16min

Shares restricted access to objects

Usage

Windows
Linux
MacOS
|
uplink share [ALLOWED_PATH_PREFIX]... [flags]


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, by default

--base-url string

the base url for link sharing, 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
|
uplink share sj://cakes/cheesecake.jpg


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

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Disallowed
Lists     : Allowed
Deletes   : Disallowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/cheesecake.jpg
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 12yUGNqdsKX1Xky2qVoGwdpL...


Share a bucket with all permissions

Windows
Linux
MacOS
|
uplink share sj://cakes/ --readonly=false


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

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Allowed
Lists     : Allowed
Deletes   : Allowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 12BncZWg9xc4GyXCgCi3YvBg...


Register with Gateway MT

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

Windows
Linux
MacOS
|
./uplink.exe share sj://cakes/ --register


Notice the endpoint generated for Gateway MT: https://gateway.storjshare.io.

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Disallowed
Lists     : Allowed
Deletes   : Disallowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/ (entire bucket)
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 1Q74vfxunqiAQ15WPxPqreya...
========== CREDENTIALS ===================================================================
Access Key ID: jvguri...
Secret Key   : j3nj4x...
Endpoint     : https://gateway.storjshare.io


Link Sharing

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

Windows
Linux
MacOS
|
uplink share sj://cakes/ --url --not-after=none --base-url=https://link.storjshare.io


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 share for details.

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Disallowed
Lists     : Allowed
Deletes   : Disallowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/ (entire bucket)
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 1Q74vfxunqiAQ15WPxPqreya...
========== CREDENTIALS ===================================================================
Access Key ID: jvguri...
Secret Key   : j3nj4x...
Endpoint     : https://gateway.storjshare.io
Public Access: true
=========== BROWSER URL ==================================================================
REMINDER  : Object key must end in '/' when trying to share recursively
URL       : https://link.storjshare.io/s/jvguri.../cakes


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 Host a Static Website with the Uplink CLI and Linksharing Service.

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
|
uplink share --dns www.mysite.com sj://cakes/ --base-url https://link.storjshare.io

Terminal
|
=========== ACCESS RESTRICTIONS ==========================================================
Download  : Allowed
Upload    : Disallowed
Lists     : Allowed
Deletes   : Disallowed
NotBefore : No restriction
NotAfter  : No restriction
Paths     : sj://cakes/ (entire bucket)
=========== SERIALIZED ACCESS WITH THE ABOVE RESTRICTIONS TO SHARE WITH OTHERS ===========
Access    : 12BncZWg9xc4GyXCDX73...
========== CREDENTIALS ===================================================================
Access Key ID: ju3ga56lfk7x...
Secret Key   : j2psszecoqtc...
Endpoint     : https://gateway.storjshare.io
Public Access:  true
=========== DNS INFO =====================================================================
Remember to update the $ORIGIN with your domain name. You may also change the $TTL.
$ORIGIN example.com.
$TTL    3600
www.mysite.com    	IN	CNAME	link.storjshare.io.
txt-www.mysite.com	IN	TXT  	storj-root:cakes
txt-www.mysite.com	IN	TXT  	storj-access:ju3ga56lfk7x...


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 09 May 2023
Did this page help you?
Yes
No
PREVIOUS
setup
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