Using a Sia node as a Portal

Accessing Skynet using a Sia Node

If you are running a fully-synced Sia node on your machine, you can download, upload and pin files to Skynet by using the command-line tool siac or using its API. This page will get you started using siac but Sia also provides API documentation.
If you need help getting Sia up and running, see the Sia Support page.
This documentation is intended for Advanced users with experience using the Sia network.
The location of siac depends on your OS and installation method. For Sia-UI users on Windows, try %APPDATA%\Local\Programs\Sia-UI\resources\bin

Pre-Requisites

You'll need:
By default, node renters do not try to create contracts with all hosts. To configure your renter as a Skynet portal, follow these instructions for configuring siad.

Skynet Commands

To see all the commands available, see the Sia Repository on Gitlab or run:
1
siac skynet --help
Copied!

Uploading to Skynet

To upload a file or directory to Skynet, use this command, where source is the location on your local filesystem and destination is the siapath to use for saving renter data locally.
1
siac skynet upload [source] [destination]
Copied!
For any of the commands, use --help for a thorough explanation of how it works. For example, for ssiac skynet upload --help we see:
After it runs, a skylink will be produced which can be shared and used to retrieve the file. If the given path is a directory it will be uploaded as a single skylink unless the --separately flag is passed, in which case all files under that directory will be uploaded individually and an individual skylink will be produced for each. All files that get uploaded will be pinned to this Sia node, meaning that this node will pay for storage and repairs until the files are manually deleted. Use the --dry-run flag to fetch the skylink without actually uploading the file.

Additional Commands

Here are some other important commands along with their help instructions to get you started.

Download

Download a file from skynet using a skylink. The download may fail unless this node is configured as a skynet portal. Use the --portal flag to fetch a skylink file from a chosen skynet portal.
1
siac skynet download [skylink] [destination]
Copied!

Pin

Pin the file associated with this skylink by re-uploading an exact copy. This ensures that the file will still be available on skynet as long as you continue maintaining the file in your renter.
1
siac skynet pin [skylink] [destination]
Copied!

Unpin

Unpin one or more pinned skyfiles or directories at the given siapaths. The files and directories will continue to be available on Skynet if other nodes have pinned them.
1
siac skynet unpin [siapath]
Copied!

Blocklist

Add space separated skylinks to the blocklist.
1
siac skynet blocklist add [skylink]
Copied!
Last modified 6mo ago