Skip to content

Commit

Permalink
Refactor 3 integration guides to use partials
Browse files Browse the repository at this point in the history
  • Loading branch information
@amozoss
amozoss committed Jan 24, 2024
1 parent b1b7240 commit 6c994ef
Show file tree
Hide file tree
Showing 3 changed files with 89 additions and 202 deletions.
118 changes: 30 additions & 88 deletions app/dcs/third-party-tools/acronis/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,131 +43,73 @@ For more details, see <https://www.acronis.com/en-us/products/>

---

## Create a Storj Account
## Set up Storj

### Create an Account

To begin, you will need to create a Storj account.

Navigate to <https://us1.storj.io/signup?partner=acronis> to sign up, or log in <https://storj.io/login> if you already have an account.
Navigate to <https://storj.io/signup?partner=acronis> to sign up, or log in <https://storj.io/login> if you already have an account.

### Create a Bucket

Once you have your Storj account you can create a bucket for your data to be stored in.

1\. Navigate to “Buckets” on the left side menu.

2\. Click “New Bucket” on the top right.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/jbnQ38ynnrWl0jnO_j-E5_comet-backup-storj-2.png)

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

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/K65vHcrJtRq4S87jICtYx_screenshot-2023-03-09-at-110429-am.png)

4\. Click **Create bucket**
{% partial file="create-bucket.md" /%}

### Generate S3 credentials

Storj has an Amazon S3 compatible API and you'll need generate S3 credentials to use it. S3 credentials consist of an **access key**, **secret key**, and **endpoint**.

Create S3 credentials in the Storj web console:

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

2\. Click **Create S3 Credentials** under the S3 Credentials block.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/EZyAl8Wux2GOlyPd70HnI_screenshot-2023-03-09-at-110900-am.png)

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/Cv1Lirp-3-OueRk-YAR8u_image.png)

4\. Click **Continue** to provide permissions

- **Permissions:** All
{% partial file="s3-credentials.md" /%}

- **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/gQ8jBHtvd5sFZFuAqth_h_image.png)

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

- **Use the current passphrase**: this is default option

- **Advanced**: you may provide a different encryption phrase either your own or generate a new one.

- **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/Uxn8zBqXQVmQvsswV3pJ2_image.png)

{% 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.
{% /callout %}

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

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/zk2JE9Z6f3vk_R2cjpdqc_image.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/xH5tgzVKXn-uK2hVfSo8e_image.png)
---

## Connecting to Storj via Backup Gateway

Before proceeding, ensure the destination storage has enough space for backups.

To set up Backup Gateway, do the following:

1\. On the **INFRASTRUCTURE** > **Networks** screen, make sure that the **ABGW private** and **ABGW public** traffic types are added to your networks.
1. On the **INFRASTRUCTURE** > **Networks** screen, make sure that the **ABGW private** and **ABGW public** traffic types are added to your networks.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Zzfpt2JpXnvew_u57s4Em_screenshot-2023-03-08-at-15302-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Zzfpt2JpXnvew_u57s4Em_screenshot-2023-03-08-at-15302-pm.png)

2\. In the left menu, click **STORAGE SERVICES** > **Backup storage**.
2. In the left menu, click **STORAGE SERVICES** > **Backup storage**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/VcMLWnSaqkHs9Rt_KV-rn_screenshot-2023-03-08-at-15353-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/VcMLWnSaqkHs9Rt_KV-rn_screenshot-2023-03-08-at-15353-pm.png)

3\. Click **Create backup storage**.
3. Click **Create backup storage**.

4\. Select **Public cloud** and click **next.**
4. Select **Public cloud** and click **next.**

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/5xj9hChjVLwVJs5QpOL-U_screenshot-2023-03-08-at-15443-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/5xj9hChjVLwVJs5QpOL-U_screenshot-2023-03-08-at-15443-pm.png)

5\. Select the node(s) to run the gateway services on and click **Next.
**
5. Select the node(s) to run the gateway services on and click **Next.
**

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/hnehZ46GqDA6tjCM2A0YU_screenshot-2023-03-08-at-15521-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/hnehZ46GqDA6tjCM2A0YU_screenshot-2023-03-08-at-15521-pm.png)

6\. Configure Public cloud with the following in their respective fields:
6. Configure Public cloud with the following in their respective fields:

- **Object Storage type**: Select AuthV2 compatible (S3).
- **Object Storage type**: Select AuthV2 compatible (S3).

- **Endpoint URL**: <https://gateway.storjshare.io>
- **Endpoint URL**: <https://gateway.storjshare.io>

- **Access Key**: Enter the access key from the S3 credentials you generated in Storj.
- **Access Key**: Enter the access key from the S3 credentials you generated in Storj.

- **Secret Key**: Enter the secret key from the S3 credentials you generated in Storj.
- **Secret Key**: Enter the secret key from the S3 credentials you generated in Storj.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/nrSFaE1HABH7hiU1PYavW_screenshot-2023-06-20-at-24524-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/nrSFaE1HABH7hiU1PYavW_screenshot-2023-06-20-at-24524-pm.png)

7\. Click **Next** on the Storage policy.
7. Click **Next** on the Storage policy.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/ysUUNOfYk4qJY7M-1Yw5H_screenshot-2023-03-08-at-20100-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/ysUUNOfYk4qJY7M-1Yw5H_screenshot-2023-03-08-at-20100-pm.png)

8\. Sign in to your Acronis account and click **Next**.
8. Sign in to your Acronis account and click **Next**.

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/SMydqxrJiWu53hMoIbliJ_screenshot-2023-03-08-at-20344-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/SMydqxrJiWu53hMoIbliJ_screenshot-2023-03-08-at-20344-pm.png)

9\. Click **Create.**
9. Click **Create.**

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/4vrgngJbaH5JLjl4HyFql_screenshot-2023-03-08-at-24028-pm.png)
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/4vrgngJbaH5JLjl4HyFql_screenshot-2023-03-08-at-24028-pm.png)

You now should be able to use Storj as a backup destination.
You now should be able to use Storj as a backup destination.
65 changes: 34 additions & 31 deletions app/dcs/third-party-tools/arq/page.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,62 +12,65 @@ metadata:

## Introduction

**Arq** is a backup software that allows you to use your own cloud storage account on a Mac or Windows-based system. You can use **Arq** with **Storj ** S3-compatible storage.
**Arq** is a backup software that allows you to use your own cloud storage account on a Mac or Windows-based system. You can use **Arq** with **Storj** S3-compatible storage.

**Main site**: [Arqbackup](https://www.arqbackup.com/) - you can download and follow the instructions to install Arq [here](https://www.arqbackup.com/download/).

## Configure Arq to use Storj DCS
## Set up Storj

**Your Storj Account**
### Create an Account

1. To begin, you need to create a Storj account. Navigate to <https://us1.storj.io/signup?partner=arq> to sign up, or log in <https://storj.io/login> if you already have an account.
To begin, you will need to create a Storj account.

2. Click on “Buckets” in the Storj DCS console and create a bucket for your Arq backups.
Navigate to <https://storj.io/signup?partner=arq> to sign up, or log in <https://storj.io/login> if you already have an account.

3. Click on “Access” in the Storj DCS console and click "[](docId:ObsfiEHKpVU7JTdGtW-3t)“
### Create a Bucket

4. Give it a name, select **_All_** permissions, and click **Encrypt My Access**.
Once you have your Storj account you can create a bucket for your data to be stored in.

5. Enter the encryption passphrase and click either on the **Copy to clipboard** link or **Download .txt** to copy or download your encryption phrase.
{% partial file="create-bucket.md" /%}

6. Confirm that you copied your Encryption Phrase to a safe place and click the **Create my Access** link.
### Generate S3 credentials

7. **Leave the resulting web page open** in your browser while you configure Arq.
{% partial file="s3-credentials.md" /%}

{% callout type="warning" %}
New Users should be presented with the option to **_Create a backup plan_**. Existing users may need to create a backup plan from a menu.
{% /callout %}
## Configure Arq to use Storj

Pick **New Backup Plan** from Arq’s File menu. Click **Add Storage Location**, choose **_Storj_**, and click **Continue**:
1. Pick **New Backup Plan** from Arq’s File menu.
{% callout type="warning" %}
New Users should be presented with the option to **_Create a backup plan_**. Existing users may need to create a backup plan from a menu.
{% /callout %}

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/N6I8rnUYX8QGa5aRKP-x0_image-34-2.png)
1. Click **Add Storage Location**, choose **_Storj_**, and click **Continue**

Copy and paste the **_Access Key_** and **_Secret Key_** values from your web browser into the **_Storj Access Key ID_** and **_Storj Secret Access Key_** fields in Arq and click **Continue**:
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/N6I8rnUYX8QGa5aRKP-x0_image-34-2.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Wrpn4kV2MWr2CPD98kuqa_image-42.png)
1. Copy and paste the **_Access Key_** and **_Secret Key_** values from your web browser into the **_Storj Access Key ID_** and **_Storj Secret Access Key_** fields in Arq and click **Continue**:

Check **Use existing bucket**, choose your bucket, and click **Continue**:
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/Wrpn4kV2MWr2CPD98kuqa_image-42.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/fNyYgCE3ujxntenNyK-ca_image-32-2.png)
1. Check **Use existing bucket**, choose your bucket, and click **Continue**:

Click **Continue** to use the storage location you just added:
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/fNyYgCE3ujxntenNyK-ca_image-32-2.png)

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/RM5tmZXEaSn36pqkbes4N_screen-shot-2022-05-27-at-94548-am-1024x814.png)
1. Click **Continue** to use the storage location you just added:

Choose an encryption password for Arq to encrypt your data **before** transmitting it (this password will never leave your computer):
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/RM5tmZXEaSn36pqkbes4N_screen-shot-2022-05-27-at-94548-am-1024x814.png)

{% callout type="warning" %}
Files are stored encrypted within the Storj network. Using Arq's encryption would add a second layer of encryption. Users may want to uncheck `Encrypt with password` when given the option. This is optional.
{% /callout %}
1. Choose an encryption password for Arq to encrypt your data **before** transmitting it (this password will never leave your computer):

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/j-ej_S6qiBjUl-c_-ggZb_screen-shot-2022-05-27-at-94638-am-1024x814.png)
{% callout type="warning" %}
Files are stored encrypted within the Storj network. Using Arq's encryption would add a second layer of encryption. Users may want to uncheck `Encrypt with password` when given the option. This is optional.
{% /callout %}

Choose which files you’d like to back up, and click **Create Backup Plan**:
![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/j-ej_S6qiBjUl-c_-ggZb_screen-shot-2022-05-27-at-94638-am-1024x814.png)

{% callout type="warning" %}
To change the schedule, the files being backed up, and many other options, click on your backup plan on the left and click “Edit…”.
{% /callout %}
1. Choose which files you’d like to back up, and click **Create Backup Plan**:

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/snmPnsOGwsJ2aQ7Ub_wiy_screen-shot-2022-05-27-at-94712-am-1024x814.png)
{% callout type="warning" %}
To change the schedule, the files being backed up, and many other options, click on your backup plan on the left and click “Edit…”.
{% /callout %}

![](https://link.storjshare.io/raw/jua7rls6hkx5556qfcmhrqed2tfa/docs/images/snmPnsOGwsJ2aQ7Ub_wiy_screen-shot-2022-05-27-at-94712-am-1024x814.png)

Congratulations, you have successfully configured Arq to back up your data to Storj DCS!
Loading

0 comments on commit 6c994ef

Please sign in to comment.