Single line install:
bash <(curl -s https://raw.githubusercontent.com/s5-dev/s5_deploy/main/install.sh)Compile Yourself: Install dart first.
git clone https://github.com/s5-dev/s5_deploy.git
cd s5_deploy
dart compile exe bin/s5_deploy.dart
sudo mv ./bin/s5_deploy.exe /usr/local/bin/s5_deploy
s5_deploy ./file/or/folder
-V, --version Gets the version number of package
-h, --help Print help dialoge.
--reset Resets local node BE CAREFUL
--static Skips resolver deploy
-n, --node Which S5 node to deploy to
(defaults to "https://s5.ninja")
-S, --seed Set seed to recover DNS Link Entry
-d, --dataKey Set the dataKey of the upload, defaults to target directory
For more details on the internals, read the S5 Docs.
Resolver Links are a S5 CID that point to a mutable registry entry as opposed to a static dataset. This means they can be updated in the future if you wish to update the contents without changing the link. This can be especially useful when used in conjunction with DNSLink to deploy static websites to traditional domains.
These Resolver Links are generated with 2 components, the user seed and the corresponding dataKey. In this implementation the dataKey is directly derived from the absolute path of the directory. So as long as the path and seed don't change, s5_deploy will automatically update the registry entry without any configuration. The ability to pass a dataKey and seed exist as well if you want to change the data path or machine.
This work is supported by a Sia Foundation grant