Skip to content

Commit

Permalink
Update help center pages
Browse files Browse the repository at this point in the history 
Update instructions and remove old screenshots.
  • Loading branch information
@boshevski
boshevski authored Aug 19, 2024
1 parent 4ebbd48 commit 5fd1b25
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 122 deletions.
18 changes: 6 additions & 12 deletions app/(docs)/dcs/objects/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,11 @@ uplink cp ~/Downloads/storj-tree.png sj://my-bucket

{% tab label="Storj Console" %}

1. Navigate to **Buckets** on the left side menu
1. Navigate to **Browse** on the left side menu

1. Select your bucket from the list
2. Open your bucket from the list

1. Select **Upload**

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-console-upload.png)
3. Click **Upload**

{% /tab %}

Expand Down Expand Up @@ -98,15 +96,11 @@ uplink cp sj://my-bucket ~/Downloads/storj-tree.png

{% tab label="Storj Console" %}

1. Navigate to **Buckets** on the left side menu

1. Select your bucket from the list

1. Click the 3-dots to show the additonal options menu
1. Navigate to **Browse** on the left side menu

1. Select **Download**
2. Open your bucket from the list

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/storj-console-download.png)
3. Click on the Download button on your file.

{% /tab %}

Expand Down
18 changes: 0 additions & 18 deletions app/(docs)/support/account-management-billing/billing/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,20 @@ Manage your Billing, Invoices and Payment methods

The Billing screen allows you to see all your projects and their **Total Estimated Charges** for the current Billing Period and **Available Balance** on the **Overview** tab. You can check **Transactions** for your STORJ deposit address on the **Payment Methods** tab. Your invoices you can see on the **Billing History** tab, your coupons and [](docId:i6OGJ9eZJC7Vw04nKSqcD) you can see and add on the **Coupons** tab.

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

You can expand any Project to see details of the charge. See [](docId:59T_2l7c1rvZVhI8p91VX) for details.

## Add a Payment Method

To add a [](docId:7U4_uu6Pzg6u2N6FpV9VE) you can switch to the **Payment Methods** tab and select **Add STORJ Tokens** or Add New Payment Method.

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

Please read the [](docId:59T_2l7c1rvZVhI8p91VX) section for details.

### Adding STORJ tokens

You can select to **Add STORJ Tokens** on the **_Billing - Payment Methods_** screen, the deposit address will be automatically generated for you.

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

If you click **Add funds** button, you will see a screen with QR code and your deposit address where you can send your STORJ tokens.

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

When you will pay the needed amount of STORJ, they will be added automatically to your **Available Balance** in USD value.

{% callout type="warning" %}
Expand All @@ -57,32 +49,22 @@ Please note, the payment will be accounted only after some amount of confirmatio

You can click the **See transactions** button in the **Billing - Payment Methods** section to see your transactions:

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

### Adding a Card

You can select to **Add New Payment Method** to add a Card to your account on the **_Billing - Payment Methods_** screen. You will be prompted to specify Card details.

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

Please provide a valid Card number, expiration date and CVC, then confirm adding a Card with the **Add Credit Card** button. We do not store your card details, they are used to register your Card on [Stripe](https://stripe.com).

## View a Previous Billing Period and Invoices

If you select the **Billing History** tab, you will see all previous invoices:

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/1i-OBeqj-5Y48u2ljqStm_image.png)

You can click on **Invoice PDF** link on the right side of the invoice to see details.

## Add Coupons

You can see your coupons on the **_Coupons_** tab of the **_Billing_** screen.

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

You can **Apply New Coupon**:

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

The added Coupon will be added as another tile.
22 changes: 2 additions & 20 deletions app/(docs)/support/account-management-billing/creating-your-account/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,6 @@ Learn more about [](docId:v0b3GtAU4dDT_1qibwCxc) under Concepts.

To register for an Account, go to Storj.io and choose Start for Free

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/KUG4mPsNpzLXMkulWZJ4W_account01.png)
Next, select your [](docId:v0b3GtAU4dDT_1qibwCxc), fill out the form and sign up. You'll receive an email asking you to verify your email address with a 6-digit one time verification code.

Next, select your [](docId:v0b3GtAU4dDT_1qibwCxc) in this example, the Americas region:

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

Choose your account type - Personal if you're an individual with a smaller project

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

Or Professional if you are part of a business interested in leveraging Storj in an application or service

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

Fill out the form and sign up. You'll receive an email asking you to verify your email address:

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

Click confirm to verify your email, then log into the Satellite Admin Console with your username and password.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/5rma6dFXWcIYqmvAAAitf_account06.png)
Enter the 6-digit code to verify your email, then log into the Storj Console with your username and password.
4 changes: 1 addition & 3 deletions app/(docs)/support/account-management-billing/payment-methods/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,7 @@ Begin by selecting "Billiing" from the "My Account" dropdown menu at the left bo

## Using a Credit Card

You can select to **Add New Payment Method** to add a Card to your account on the **_Billing - Payment Methods_** screen. You will be prompted to specify Card details.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/C4o1JavxukxpIrcIEGW-B_image.png)
You can select to **Add New Card** to add a Card to your account on the **_Billing - Payment Methods_** screen. You will be prompted to specify Card details.

You’ll be prompted to add your card information. Using a credit card is somewhat self-explanatory, but there are some key points users should understand:

Expand Down
2 changes: 0 additions & 2 deletions app/(docs)/support/dashboard/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ Learn more about Projects in [](docId:M-5oxBinC6J1D-qSNjKYS) under Concepts.

On the Project Dashboard, there are a number of navigational elements and information displays:

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

1. **Projects management** - This element allows you to add Projects and switch between different Projects. There you also have a [](docId:jwCUqpDCk8CUuUqFuykFx) setting.

2. **Project Navigation** - This element allows you to move between the different functions related to the project you have selected, to view the [](docId:k6QwBZM3hnzxkCuQxLOal), use the [](docId:4oDAezF-FcfPr0WPl7knd) to interact with data stored on Storj through a web browser interface, create [](docId:XKib9SzjtEXTXWvdyYWX6) for native integrations and credentials for the [](docId:yYCzPT8HHcbEZZMvfoCFa), invite other developers to collaborate with you on your project in [](docId:0_4hY4Dp5ju9B8Ec6OTf3), see [](docId:Hurx0SirlRp_O5aUzew7_), and **Quick Start**, and manage your Account in **My Account**.
Expand Down
48 changes: 7 additions & 41 deletions app/(docs)/support/object-browser/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,28 +22,20 @@ By using hosted Gateway MT you are opting into **server-side encryption**. See [

## Configure Object Browser Access

**Navigate to the** [](docId:pxdnqsVDjCLZgeEXt2S6x) page within your project. If you do not have any buckets yet - we will create a `demo-bucket` for you.
**Navigate to the** [](docId:pxdnqsVDjCLZgeEXt2S6x) page within your project.

When you click on the bucket, you will be prompted to read carefully - The object browser uses [](docId:hf2uumViqYvS1oq8TYbeW).

{% callout type="info" %}
Don't forget to save your **Encryption Passphrase** generated below, you will need it for future access.
{% /callout %}

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

If this is your first time using the object browser, you **must create an encryption passphrase.** We strongly encourage you to use a mnemonic phrase. The GUI automatically generates one on the client side for you with the **Generate passphrase** option. You can also download it as a text file.

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

Alternatively, you can enter your own passphrase using the **Enter passphrase** option. Finish selection by click on **Continue** button.

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

To continue, you need to mark the checkbox **_\[v] I understand, and I have saved the passphrase._** This will enable the **Continue** button.

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

When you click the **Continue** button, you will be placed into the **Objects** view if you already have buckets, otherwise a new bucket **_demo-bucket_** will be created and you will be placed into that bucket view.

## Upload files and folders
Expand All @@ -56,59 +48,45 @@ To upload larger files, please utilize the [](docId:TbMdOGCAXNWyPpQmH6EOq).

If you have not yet created a bucket, the bucket **_demo-bucket_** will be created automatically to allow you to upload objects right away.

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

To upload your first object, **drag it into the browser** or select **Upload File** and browse to the file you wish to upload.

You can upload not only files but also folders, just **drag them into the browser** or select **Upload Folder** and browse to the folder you wish to upload.

If you want to create a folder, you can do that with the **New Folder** button.

{% callout type="success" %}
When you drag and drop your file into the Satellite Admin Console Object Browser, the Storj S3-compatible Gateway will encrypt the data using [](docId:hf2uumViqYvS1oq8TYbeW), break large files into 64MB Segments (or for smaller files a single segment), then erasure code the segments, breaking each segment into 80 pieces, then distributing those pieces over our network of thousands of independently operated storage nodes.
When you drag and drop your file into the Storj console, the Storj S3-compatible Gateway will encrypt the data using [](docId:hf2uumViqYvS1oq8TYbeW), break large files into 64MB Segments (or for smaller files a single segment), then erasure code the segments, breaking each segment into 80 pieces, then distributing those pieces over our network of thousands of independently operated storage nodes.
{% /callout %}

## Deleting files

1. If you select the three vertical dots on the right side of a file, a popup menu will appear:

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

2. Select the **Delete** command.

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

3. Confirm deletion with **Yes**.
3. Confirm deletion with **Delete**.

## Creating buckets

Buckets are your containers that store objects.

You can create your buckets in the **Objects** view or if you click on the **<-Back to Buckets** button, in the bucket view.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/oJ74hmgmN9h5iDemALwMk_qsobject07.png)
You can create your buckets in the **Browse** view or if you click on the **<-Back to Buckets** button, in the bucket view.

{% callout type="warning" %}
The bucket name can only contain lowercase letters, numbers, and hyphens.
{% /callout %}

To create a new bucket, click the **New bucket** button in the **Buckets** view. A new module window will pop up called **Create Bucket**. Please provide a name using only lower case alphanumeric characters and dashes (this is a limitation for compatibility with existing object storages).

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Yewew2V1tdS66o93P_XIM_qsobject08.png)
To create a new bucket, click the **New bucket** button in the **Browse** view. A new module window will pop up called **Create Bucket**. Please provide a name using only lower case alphanumeric characters and dashes (this is a limitation for compatibility with existing object storages).

After creating your new bucket, you will be placed into the bucket where you can [](docId:gh5RtIDbMkAoomljO7f8d)

## Deleting buckets

1. Clicking the three vertical dots on the right side of the bucket, a popup menu will appear:

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

2. Click the **Delete** command

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

3. Type the **_Bucket Name_** and **Confirm Delete Bucket**.
3. Type the **_Bucket Name_** and **Delete Bucket**.

{% callout type="warning" %}
Be careful when deleting buckets - If you still have objects in the bucket being deleted, they will be deleted too!
Expand All @@ -118,30 +96,18 @@ Be careful when deleting buckets - If you still have objects in the bucket being

After an upload completes, you will have the option of creating a share link. If you wish, click the file name - it will open a preview with a map. Here you can click the **Share** button.

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

Or you can click on the three vertical dots to the right of the file you want to share, and select **Share** to share your object.

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

The **Share** pop-up window allows you to share the link via social media or copy it with **Copy Link**.

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

The share link includes a rendering of where the pieces of your file are located on the globally distributed network of storage nodes, as well as a preview of that file.

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

## Share a bucket

1. Click the three vertical dots to the right of the bucket, a popup menu will appear

![Share Bucket](https://link.storjshare.io/raw/juc6cqmbtg2qgaja6jzx67zfkjwa/docs/images/Share-Bucket.png)

2. Click the **Share Bucket** command

![Share the link](https://link.storjshare.io/raw/jwkhjjn4le4udilzxbeoe3wj7iwa/docs/images/Share%20a%20link.png)

3. Click the needed button to share the link
3. Click the copy button to copy and share the link

This concludes the Object Browser Quickstart.
20 changes: 0 additions & 20 deletions app/(docs)/support/projects/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ Learn more about Projects in [](docId:M-5oxBinC6J1D-qSNjKYS) under Concepts.

To select, create or **Manage Projects** you can click the name of your project on the left side toolbar above Dashboard.

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

## Create a new Project

On **_Projects_** screen to create a new Project select the **Create Project**. On Project **Dashboard** you can click the name of the current project and select **Create Project**.
Expand All @@ -34,24 +32,18 @@ On **_Projects_** screen to create a new Project select the **Create Project**.
The availability of this function depends on your account tier. Please check [](docId:Zrbz4XYhIOm99hhRShWHg) for details.
{% /callout %}

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

Specify the **Project Name**, optional **Description** and confirm the creating with the **Create Project** button.

## Modify the existing Project

To modify the existing Project on the **_Projects_** screen you can select a needed project and modify its name or description.

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

## Changing Project Limits

If your account tier allows you to change your [](docId:Zrbz4XYhIOm99hhRShWHg), you will have more options than a free plan.

Select **Edit** to the right of the limit to change it. However, it will not allow to increase limits greater than your available maximum. To change the maximum you need to file a support request to change your limits, see [](docId:A4kUGYhfgGbVhlQ2ZHXVS).

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

## Delete the existing Project

At the moment the Satellite Admin Console will not allow you to delete a Project.
Expand All @@ -70,27 +62,18 @@ We do not have an access to your data and Access Grants, because they are encryp

You may manage your [Passphrase](docId:M-5oxBinC6J1D-qSNjKYS#encryption-key) used for [Buckets](docId:4oDAezF-FcfPr0WPl7knd) view.

![](https://link.storjshare.io/raw/jvqobk4svumlsdxgn66o4heyi75q/docs%2Fimages%2FManage%20Passphrase%202023-12-28%20102824.png)

The **Manage Passphrase** window will allow you to:
* [Create a new Passphrase](#create-a-new-passphrase)
* [Switch current Passphrase](#switch-the-current-passphrase)
* [Clear saved Passphrase](#clear-the-saved-passphrase)

![](https://link.storjshare.io/raw/ju5pajakxkq6iykj33fueoyzwjya/docs%2Fimages%2FManage%20Passphrase%20-%20choice%202023-12-28%20103213.png)

### Create a new Passphrase

![](https://link.storjshare.io/raw/jvodweijki7eso7z2u4rd2oawika/docs%2Fimages%2FCreate%20a%20new%20passphrase%202023-12-28%20103850.png)

After click the **Continue** button you will have a choice how do you want to provide your Encryption Passphrase:
* [Generate a 12-words Encryption Passphrase](#generate-12-word-passphrase)
* [Enter your own Encryption Passphrase](#enter-a-new-passphrase)

![](https://link.storjshare.io/raw/jwutrovcovetzu3lhi7j2wxgfgxq/docs%2Fimages%2FEncryption%20Passphrase%202023-12-28%20104218.png)

#### Generate 12-word passphrase
![](https://link.storjshare.io/raw/jx57khok3xb4t52trdjmjhhrammq/docs%2Fimages%2FPassphrase%20Generated%202023-12-28%20104455.png)

Now you may:
* **Copy** the generated Passphrase
Expand All @@ -100,16 +83,13 @@ Now you may:
You need to select a checkbox **[ ] Yes, I saved my encryption passphrase** to **Continue**

#### Enter a new passphrase
![](https://link.storjshare.io/raw/jw34uudu6bmdzycjed7vr726rxzq/docs%2Fimages%2FEnter%20Passphrase%202023-12-28%20105653.png)

You should enter your own Encryption Passphrase (or a previously used), select a checkbox **[ ] Yes, I saved my encryption passphrase** to **Continue**

### Switch the current Passphrase
![](https://link.storjshare.io/raw/jubisqg4sjzbk7t7nx3w4bzjavya/docs%2Fimages%2FSwitch%20Passphrase%202023-12-28%20110317.png)

You should enter your own Encryption Passphrase (or a previously used) to **Continue**

### Clear the saved Passphrase
![](https://link.storjshare.io/raw/jwzhuxi7onvp7jc7cfgdipnlmqra/docs%2Fimages%2FClear%20my%20passphrase%202023-12-28%20110818.png)

Click the **Continue** button to clear your currently saved Encryption Passphrase
Loading

0 comments on commit 5fd1b25

Please sign in to comment.