Skip to content

Commit f42d7b2

Browse files
committed
Tidy up docs.
1 parent 07a3c0e commit f42d7b2

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

docs/source/pages/get_started/set-up-a-project.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -551,36 +551,34 @@ Running [](setup_aws_connection()) will require entering your
551551

552552

553553
(password-protection)=
554-
# Password protecting your connection credentials
554+
# Encrypting your connection credentials
555555

556-
Datashuttle uses [RClone](https://rclone.org/) for all data transfers by default.
557-
RClone stores connection credentials (such as SSH keys or API tokens) in a local configuration file that, by default, is not encrypted.
556+
Datashuttle uses [RClone](https://rclone.org/) for all data transfers.
557+
RClone stores connection credentials in a
558+
local configuration file that, by default, is not encrypted.
558559

559560
This file can include:
560561

561-
- SSH connections: your private SSH key
562-
- Google Drive connections: your OAuth access token and client secret
563-
- Amazon S3 connections: your AWS Access Key ID and Secret Access Key
562+
- **SSH:** your private SSH key
563+
- **Google Drive:** your OAuth access token and client secret
564+
- **Amazon S3:** your AWS Access Key ID and Secret Access Key
564565

565-
By default, these are stored in your home directory which should be secure. However, for an
566+
These are stored in your home directory, which is expected to be secure. However, for an
566567
additional layer of security, it is possible to encrypt the Rclone config file using the
567568
system credential manager of your operating system. This file will then be
568569
unreadable for anyone who does not have access to your machine user account. Note that
569570
anyone with access to the machine user account will be able to decrypt the Rclone file.
570571

571-
Despite this layer of security, it is not recommended to use datashuttle for remote connectivity on
572-
a machine to which you do not have secure access, even with user account encryption of the RClone config.
573-
574572
For details on setting up encryption, see the section below. On Windows, you will
575573
need to be running in PowerShell, and on Linux you will need `pass` package installed.
576574

577575
::::{tab-set}
578576

579577
:::{tab-item} Windows
580578

581-
On Windows, Datashuttle uses the PowerShell `PSCredential` system to encrypt the RClone config file.
579+
On Windows, the PowerShell `PSCredential` system to encrypt the RClone config file.
582580

583-
- A random password is generated and stored as a `.clixml` credential file under a `credentials` folder in the project config location.
581+
- A random password is generated and stored as a `.clixml` credential file.
584582
- The password can only be decrypted by the same Windows user account that created it.
585583
- The encryption and decryption process uses PowerShell, so PowerShell must be available (it will not work from `cmd.exe`).
586584

@@ -590,7 +588,7 @@ When encryption is enabled, RClone automatically retrieves the password from the
590588

591589
:::{tab-item} macOS
592590

593-
On macOS, Datashuttle uses the built-in Keychain via the `security` command-line tool.
591+
On macOS, the built-in Keychain via the `security` command-line tool is used.
594592

595593
- A random password is generated using `openssl rand -base64 40`.
596594
- The password is securely stored in your login Keychain under the service name corresponding to your RClone config.
@@ -603,11 +601,12 @@ Once approved, RClone will automatically retrieve the key when needed.
603601

604602
:::{tab-item} Linux
605603

606-
1. Install `pass`:
604+
On Linux, the `pass` package is used to manage the encryption. You can install it with:
607605
```bash
608606
sudo apt install pass
609607
```
610-
2. Initialize the password store with your GPG key:
608+
609+
Next, you need to initialize the password store with your GPG key:
611610
```bash
612611
pass init <your-gpg-id>
613612
```
@@ -626,7 +625,7 @@ Once initialized, Datashuttle will:
626625

627626
## Removing encryption
628627

629-
Encryption of the rclone config used for the central connection (either SSH, Google Drive or AWS)
630-
can be removed with the following command:
628+
Encryption of the Rclone config file used for the central connection
629+
(either SSH, Google Drive or AWS) can be removed with the following command:
631630

632631
[](remove_rclone_encryption())

0 commit comments

Comments
 (0)