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 Dec 14, 2023
1 parent 609b503 commit 00a22cf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 16 deletions.
22 changes: 13 additions & 9 deletions RENT.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This version is fully compatible with the original `renterd` metadata-wise. This

It's also very easy to switch the Satellite mode on and off, and also change the Satellite. With the Satellite enabled, your `renterd` will be forming contracts using the Satellite you chose. When you disable the Satellite, it will be using its own wallet.

NOTE: In order to prevent a malicious (or just curious) satellite operator from accessing your files, the modified version of `renterd` offers a client-side encryption of any data and/or metadata transferred to the satellite. Unfortunately, this means that encrypted files cannot be decrypted on the original `renterd` later on.

## Download the Renting Software

Download and install the latest version from [https://github.com/mike76-dev/renterd/releases](https://github.com/mike76-dev/renterd/releases). If you prefer to build from source, make sure you're building the `satellite` branch and not `master`.
Expand Down Expand Up @@ -34,11 +36,15 @@ 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
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
Encrypt Data: check if you want your data to be encrypted before uploading (see above)
Encryption Key: the key used to encrypt your data; you can use this key to view and
download your files on the Satellite web portal
(this is a read-only field)
```
When you have finished, enable the Satellite and save the config.

Expand All @@ -60,10 +66,8 @@ This option needs both _Auto Renew Contracts_ and _Backup File Metadata_ to be e
### 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` versions of `renterd` now offer a client-side encryption of 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.
The Satellite page of the `renterd` UI shows the encryption key used to encrypt your data. You can copy this key and 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.
14 changes: 7 additions & 7 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.8.0` for an x86 CPU:
Log into your server and download the Satellite files. This guide assumes that you will use the version `0.9.0` for an x86 CPU:
```
mkdir ~/satellite
cd ~/satellite
wget -q https://github.com/mike76-dev/satellite/releases/download/v0.8.0/satellite_linux_amd64.zip
wget -q https://github.com/mike76-dev/satellite/releases/download/v0.9.0/satellite_linux_amd64.zip
unzip satellite_linux_amd64.zip
rm satellite_linux_amd64.zip
```
Expand Down Expand Up @@ -510,7 +510,7 @@ 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]: satd v0.9.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...
Expand Down Expand Up @@ -540,10 +540,10 @@ Once the node is synced, the output will change:
```
Output:
Synced: Yes
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
Block: bid:0000000000000001090c306294fd37218f2dcfd851ea52b43fb608a8479887f3
Height: 448299
Target: [0 0 0 0 0 0 0 1 18 199 150 23 29 10 55 177 95 226 182 18 239 59 254 34 226 48 104 226 81 92 121 204]
Difficulty: ~17.19 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 00a22cf

Please sign in to comment.