Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mike76-dev
mike76-dev committed Nov 18, 2023
1 parent 99e5fc0 commit b8ed4c5
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 28 deletions.
12 changes: 11 additions & 1 deletion RENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Once a payment has been made to your account, you will be able to see the Satell
Once your `renterd` is fully synced, navigate to the Satellite page and enter the following configuration:
```
Address: the network address of the Satellite including the port number
Mux Port: the port of the Satellite listening to RHP3 calls (defaults to 9993)
Public Key: the public key displayed on the Account page of the Satellite portal,
without the 'ed25519:' prefix
Renter Seed: the renter seed displayed on the Account page of the Satellite portal
Expand All @@ -56,4 +57,13 @@ By enabling this option, `renterd` will save any file metadata on the Satellite
### File Auto Repair
This option needs both _Auto Renew Contracts_ and _Backup File Metadata_ to be enabled to work. When you enable it, the Satellite takes over almost all contract maintenance: contract formations, renewals, and refreshes, as well as monitoring the file health and migrating unhealthy slabs to new hosts. Enabling this option allows you to turn on `renterd` only if you need to upload or download files, which you can do as often as you like, even once in a few years. The only thing you need to care of is maintaining a positive balance with the Satellite.

IMPORTANT: Please note that S3 interface and upload packing are not supported yet.
### Proxy Uploads through Satellite
When you enable this option, you upload your files directly to the Satellite, which saves your bandwidth and is usually much faster. The Satellite then uploads these files to the network in the background. The downside of this is that you don't see the uploaded files in `renterd` immediately, but only on the next autopilot loop iteration, when the file metadata is imported from the Satellite.

IMPORTANT: Please note that S3 interface is not fully supported yet.

## Data Encryption

The `-satellite` versions of `renterd` now encrypt the files before uploading. If you choose to backup the file metadata on the Satellite, the Satellite operator will not be able to read the contents of the files or even their names. This way, you can enjoy the full privacy when sharing your file metadata with the Satellite.

The Satellite page of the `renterd` UI shows the encryption key used to encrypt your data. You can copy this key end paste it on your dashboard of the Satellite web portal, this will allow you to view your saved files and download them from the dashboard. The key is not transferred to the Satellite, which means that only you can access your data.
55 changes: 28 additions & 27 deletions SETUP.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ You will also need an email account, from which the users will be receiving emai

## To Start With

Log into your server and download the Satellite files. This guide assumes that you will use the version `0.6.0` for an x86 CPU:
Log into your server and download the Satellite files. This guide assumes that you will use the version `0.8.0` for an x86 CPU:
```
mkdir ~/satellite
cd ~/satellite
wget -q https://github.com/mike76-dev/satellite/releases/download/v0.6.0/satellite_linux_amd64.zip
wget -q https://github.com/mike76-dev/satellite/releases/download/v0.8.0/satellite_linux_amd64.zip
unzip satellite_linux_amd64.zip
rm satellite_linux_amd64.zip
```
Expand Down Expand Up @@ -415,13 +415,14 @@ $ nano satdconfig.json
First, choose a `name` of your satellite node (Hint: it makes sense to use your domain name for it). This is required to receive email reports later on. Fill in the `dbUser` and `dbName` fields with the MySQL user name (`satuser`) and the database name (`satellite`). Set the directory to store the `satd` metadata and log files (here it is `/usr/local/etc/satd`). You can also change the default portal API port number (`:8080`) as well as the other ports:
```
"Satd Configuration"
"0.2.0"
"0.3.0"
{
"name": "your_chosen_name",
"agent": "Sat-Agent",
"gateway": ":0",
"api": "localhost:9990",
"satellite": ":9992",
"mux": ":9993",
"dir": "/usr/local/etc/satd",
"bootstrap": true,
"dbUser": "satuser",
Expand Down Expand Up @@ -523,26 +524,26 @@ $ journalctl -u satd -f
If everything went well, you should see the following output:
```
Output:
Jul 31 15:16:17 <host> systemd[1]: Started satd.
Jul 31 15:16:17 <host> satd[226480]: Using SATD_CONFIG_DIR environment variable to load config.
Jul 31 15:16:17 <host> satd[226480]: Using SATD_API_PASSWORD environment variable.
Jul 31 15:16:17 <host> satd[226480]: Using SATD_DB_PASSWORD environment variable.
Jul 31 15:16:17 <host> satd[226480]: satd v0.6.0
Jul 31 15:16:17 <host> satd[226480]: Git Revision 2f5a918
Jul 31 15:16:17 <host> satd[226480]: Loading...
Jul 31 15:16:17 <host> satd[226480]: Creating mail client...
Jul 31 15:16:17 <host> satd[226480]: Connecting to the SQL database...
Jul 31 15:16:17 <host> satd[226480]: Loading gateway...
Jul 31 15:16:17 <host> satd[226480]: Loading consensus...
Jul 31 15:16:17 <host> satd[226480]: Loading transaction pool...
Jul 31 15:16:17 <host> satd[226480]: Loading wallet...
Jul 31 15:16:17 <host> satd[226480]: Loading manager...
Jul 31 15:16:18 <host> satd[226480]: Loading provider...
Jul 31 15:16:18 <host> satd[226480]: Loading portal...
Jul 31 15:16:18 <host> satd[226480]: API is now available, synchronous startup completed in 0.019 seconds
Jul 31 15:16:18 <host> satd[226480]: Wallet Password found, attempting to auto-unlock wallet...
Jul 31 15:16:18 <host> satd[226480]: Auto-unlock failed: provided encryption key is incorrect
Jul 31 15:16:18 <host> satd[226480]: Finished full setup in 0s
Nov 18 15:16:17 <host> systemd[1]: Started satd.
Nov 18 15:16:17 <host> satd[226480]: Using SATD_CONFIG_DIR environment variable to load config.
Nov 18 15:16:17 <host> satd[226480]: Using SATD_API_PASSWORD environment variable.
Nov 18 15:16:17 <host> satd[226480]: Using SATD_DB_PASSWORD environment variable.
Nov 18 15:16:17 <host> satd[226480]: satd v0.8.0
Nov 18 15:16:17 <host> satd[226480]: Git Revision 2f5a918
Nov 18 15:16:17 <host> satd[226480]: Loading...
Nov 18 15:16:17 <host> satd[226480]: Creating mail client...
Nov 18 15:16:17 <host> satd[226480]: Connecting to the SQL database...
Nov 18 15:16:17 <host> satd[226480]: Loading gateway...
Nov 18 15:16:17 <host> satd[226480]: Loading consensus...
Nov 18 15:16:17 <host> satd[226480]: Loading transaction pool...
Nov 18 15:16:17 <host> satd[226480]: Loading wallet...
Nov 18 15:16:17 <host> satd[226480]: Loading manager...
Nov 18 15:16:18 <host> satd[226480]: Loading provider...
Nov 18 15:16:18 <host> satd[226480]: Loading portal...
Nov 18 15:16:18 <host> satd[226480]: API is now available, synchronous startup completed in 0.019 seconds
Nov 18 15:16:18 <host> satd[226480]: Wallet Password found, attempting to auto-unlock wallet...
Nov 18 15:16:18 <host> satd[226480]: Auto-unlock failed: provided encryption key is incorrect
Nov 18 15:16:18 <host> satd[226480]: Finished full setup in 0s
```
The daemon will now be syncing to the blockchain. You can monitor the progress with the following command:
```
Expand All @@ -557,10 +558,10 @@ Once the node is synced, the output will change:
```
Output:
Synced: Yes
Block: bid:00000000000000013c202585e95d03c2614e99c0fc74c45abfbbef6c3327bec4
Height: 428683
Target: [0 0 0 0 0 0 0 1 75 152 56 175 21 91 242 148 66 247 215 220 161 236 232 219 132 237 129 170 88 165 124 154]
Difficulty: ~14.24 uS
Block: bid:00000000000000000b9b687a2794ff4dd450bfed6f7fc452e27bcf2a433d8d93
Height: 444562
Target: [0 0 0 0 0 0 0 1 35 47 52 114 83 128 110 166 227 1 23 115 197 236 127 4 15 91 59 30 228 136 86 160]
Difficulty: ~16.22 uS
```
You should now create a wallet. You will need the password you set in your `systemd` unit earlier. When prompted type in the wallet password you chose.
```
Expand Down

0 comments on commit b8ed4c5

Please sign in to comment.