Skip to content

Commit

Permalink
Update docs and images
Browse files Browse the repository at this point in the history
Update instructions for Access Keys and remove old screenshots.
  • Loading branch information
boshevski authored Aug 19, 2024
1 parent 5130616 commit 4ebbd48
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 69 deletions.
20 changes: 4 additions & 16 deletions app/(docs)/dcs/access/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,15 @@ The Access Grant screen allows you to create or delete Access Grants, generate c

## Create Keys for CLI

1. You need to have a satellite account and Uplink CLI installed. See [](docId:HeEf9wiMdlQx9ZdS_-oZS)
1. You need to have a Storj account and Uplink CLI installed. See [](docId:HeEf9wiMdlQx9ZdS_-oZS)

2. To start, proceed through the initial steps of creating a new Access Grant.

3. Navigate to "Access" page and click the **Create Keys for CLI** link (rightmost option).
3. Navigate to "Access Keys" page and click the **New Access Key** button, then type an access name and choose **API Key** as an Access type.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/dBMRUSzPsBClfxJaXwk7S_cli-keys.png)
4. On the next step, select either **Full Access** or **Advanced** if you want to choose the permissions, buckets, and set an expiry date for this access key.

4. Provide name, permissions and optionally buckets, select **Create Keys**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/NZGAlqeSEv-vuzJW1enUW_cli-keys2.png)

5. Copy and save the **Satellite Address** and **API Key **in a safe place or download them as they will only appear once.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/68ftNpbXKmJkroQyO2C9Q_cli-keys3.png)
5. Once you create the access key, copy and save the **Satellite Address** and **API Key** in a safe place, or download them as they will only appear once.

6. Make sure you've already [](docId:hFL-goCWqrQMJPcTN82NB) and run `uplink setup`.

Expand Down Expand Up @@ -109,12 +103,6 @@ The alternative for using the uplink setup command and then uplink share is to u

To Delete an Access Grant, select three dots on the right side of the Access Grant and choose **Delete Access**:

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/8DjOwU27KCkISKOJs9T3O_access10.png)

Then confirm that you want to delete the Access Grant by typing its name and confirming with **Delete Access** button.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/--lULF4MsGMwhbtfyIa5W_access11.png)

{% callout type="danger" %}
**Important:** If you delete an Access Grant from the Satellite user interface, that Access Grant will immediately cease to function, and all hierarchically derived child Access Grants and Storj gateway access credentials based on that Access Grant will also cease to function. Any data uploaded with that Access Grant will persist on Storj. If you didn't back up the Encryption Passphrase used with the Access Grant you are deleting, you will not be able to decrypt that data without that Encryption Passphrase, and it will be effectively unrecoverable.
{% /callout %}
Expand Down
2 changes: 0 additions & 2 deletions app/(docs)/dcs/migrate/backblaze/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,5 +143,3 @@ rclone check backblaze:my-backblaze-bucket storj:my-backblaze-bucket
This command will compare the source (Backblaze) and destination (Storj) and report any discrepancies.

You can also see the contents of your Backblaze bucket in the Storj Web Console.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/b2_bucket_on_storj.png)
2 changes: 0 additions & 2 deletions app/(docs)/dcs/migrate/wasabi/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,5 +142,3 @@ rclone check wasabi:my-wasabi-bucket storj:my-wasabi-bucket
This command will compare the source (Wasabi) and destination (Storj) and report any discrepancies.

You can also see the contents of your Wasabi bucket in the Storj Web Console.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/k_hZRrlzb3x4CqXweWmoD_screenshot-2023-07-05-at-30729-pm.png)
30 changes: 8 additions & 22 deletions src/markdoc/partials/create-access-grant.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,31 +2,24 @@ A Storj access grant is a serialized, self-contained credential that allows user

Create Access Grant in the Storj Console:

1. Navigate to **Access** on the left side menu.
1. Navigate to **Access Keys** on the left side menu.

2. Click **Create Access Grant** under the Access Grant block
2. Click the **New Access Key** button.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/I0a-_XJBVJRkWobIDMI6P_screenshot-2023-07-05-at-22016-pm.png)

3. When the Create Access screen comes up, set specifications according to the following guidelines:

- **Type:** Access Grant
3. When the New Access dialog comes up, set specifications according to the following guidelines:

- **Name:** The name of the credentials (e.g. my-access-grant)
- **Type:** Access Grant

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/ezY2HJuPFEsgyH4p13ebP_screenshot-2023-07-05-at-22057-pm.png)

4. Click **Continue** to provide permissions
4. Click **Next** to provide permissions, either Full Access or Advanced:

- **Permissions:** All

- **Buckets:** Feel free to specify the bucket (e.g. my-bucket), or leave as “All”

- **End date**: provide an expiration date for these credentials (optional)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/gQ8jBHtvd5sFZFuAqth_h_image.png)

5. Click **Continue** to provide Access encryption Information
5. Click **Next** to provide Access encryption Information

{% callout type="warning" %}
In order to see the data uploaded to your bucket in the web console, you must unlock the bucket with the same encryption passphrase as the credentials.
Expand All @@ -40,9 +33,6 @@ Create Access Grant in the Storj Console:

- **Generate 12-word passphrase**: use this option, if you would like to generate a new encryption phrase

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Uxn8zBqXQVmQvsswV3pJ2_image.png)


{% callout type="warning" %}
**This passphrase is important!** Encryption keys derived from it are used to encrypt your data at rest, and your data will have to be re-uploaded if you want it to change!

Expand All @@ -51,12 +41,8 @@ Importantly, if you want two access grants to have access to the same data, **th
Please note that **Storj does not know or store your encryption passphrase**, so if you lose it, you will not be able to recover your files.
{% /callout %}

6. Click **Create Access** to finish creation of your S3 credentials
6. Click **Create Access** to finish creation of your Access key.

7. Click **Confirm** the Confirm details pop-up message

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/WAgyNSbTLK8aR3W8btpMg_screenshot-2023-07-05-at-22143-pm.png)

8. Your Access Grant is created. Write them down and store them, or click the **Download all** button. You will need these credentials for the following steps.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/5c73MkTyjkYBJkkQ42yUF_screenshot-2023-07-05-at-22152-pm.png)
8. Your Access Grant is created. Write it down and store it, or click the **Download** button. You will need the Access Grant for the following steps.
10 changes: 3 additions & 7 deletions src/markdoc/partials/create-bucket.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
1. Navigate to **Buckets** on the left side menu.
1. Navigate to **Browse** on the left side menu.

2. Click **New Bucket** on the top right.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/create_bucket_1.png)
2. Click on the **New Bucket** button.

3. Assign the bucket an easily identifiable name, such as "my-bucket".

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/create_bucket_2.png)

4. Click **Create bucket**
4. Click **Create bucket**
28 changes: 8 additions & 20 deletions src/markdoc/partials/s3-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,22 @@ Storj has an Amazon [S3 compatible API](docId:eZ4caegh9queuQuaazoo) and you'll n

Create S3 credentials in the Storj console:

1. Navigate to **Access** on the left side menu.
1. Navigate to **Access Keys** on the left side menu.

2. Click **Create S3 Credentials** under the S3 Credentials block.
2. Click the **New Access Key** button.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_1.png)
3. When the New Access dialog comes up, set specifications according to the following guidelines:

3. When the Create Access screen comes up, set specifications according to the following guidelines:

- **Type:** S3 Credentials
- **Name:** The name of the credentials (e.g. my-access)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_2.png)

4. Click **Continue** to provide permissions
- **Type:** S3 Credentials

4. Click **Next** to provide permissions, either Full Access or Advanced:

- **Permissions:** All
- **Buckets:** Feel free to specify the bucket you created above (e.g. my-bucket), or leave as “All”
- **End date**: provide an expiration date for these credentials (optional)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_3.png)

5. Click **Continue** to provide Access encryption Information
5. Click **Next** to provide Access encryption Information
{% callout type="warning" %}
In order to see the data uploaded to your bucket in the Storj console, you must unlock the bucket with the same encryption passphrase as the credentials.
{% /callout %}
Expand All @@ -33,14 +27,8 @@ Create S3 credentials in the Storj console:
- **Enter a new passphrase**: use this option, if you would like to provide your own new encryption phrase
- **Generate 12-word passphrase**: use this option, if you would like to generate a new encryption phrase

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_4.png)

6. Click **Create Access** to finish creation of your S3 credentials

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_5.png)

7. Click **Confirm** the Confirm details pop-up message

8. Your S3 credentials are created. Write them down and store them, or click the **Download all** button. You will need these credentials for the following steps.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/s3_credentials_6.png)
8. Your S3 credentials are created. Write them down and store them, or click the **Download all** button. You will need these credentials for the following steps.

0 comments on commit 4ebbd48

Please sign in to comment.