https://github.com/s5-dev/s5_deploy
Simple CLI to Deploy Static Websites to S5
https://github.com/s5-dev/s5_deploy
Last synced: 4 months ago
JSON representation
Simple CLI to Deploy Static Websites to S5
- Host: GitHub
- URL: https://github.com/s5-dev/s5_deploy
- Owner: s5-dev
- Created: 2024-06-04T15:17:56.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-26T17:28:04.000Z (almost 2 years ago)
- Last Synced: 2025-11-29T23:57:13.415Z (6 months ago)
- Language: Dart
- Size: 53.7 KB
- Stars: 3
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
S5 Deploy
Simple CLI to Deploy Static Websites to S5
## Install
**Single line install**:
```bash
bash <(curl -s https://raw.githubusercontent.com/s5-dev/s5_deploy/main/install.sh)
```
**Compile Yourself**:
[Install dart](https://dart.dev/get-dart#install) 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
```
## Usage
```
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
```
### Guide to Resolver Links
For more details on the internals, read the [S5 Docs](https://docs.sfive.net/concepts/registry.html).
Resolver Links are a S5 [CID](https://docs.sfive.net/concepts/content-addressed-data.html) 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](https://dnslink.org/) 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.
## Acknowledgement
This work is supported by a [Sia Foundation](https://sia.tech/) grant