Skip to content

Commit

Permalink
Merge pull request #5865 from EnterpriseDB/docs/edits_to_repos_pr5816
Browse files Browse the repository at this point in the history
Edits to DOCS-726 - Repos section for docs
  • Loading branch information
ebgitelman authored Jul 22, 2024
2 parents 89f9691 + 3d8720c commit 9444d7a
Show file tree
Hide file tree
Showing 19 changed files with 182 additions and 187 deletions.
10 changes: 6 additions & 4 deletions advocacy_docs/repos/getting_started/index.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
---
title: Getting started with repositories
navTitle: Getting Started
navTitle: Getting started
description: How to download and install the EDB package you need
navigation:
- with_web
- with_cli
- troubleshooting
---

* [Using the web page](with_web): If you have an Enterprise subscription to EDB software, and want to use the web interface to guide you in downloading and installing packages, use this guide.
You can get started with your repository using either of these approaches:

* [Using the CLI](with_cli): For all subscriptions, you can use the CLI to install packages from EDB repositories. This guide works for all EDB repositories and is the most flexible way to install packages.
* [Use the web page](with_web) if you have an Enterprise subscription to EDB software and want to use the web interface to guide you through downloading and installing packages.

* [Use the CLI](with_cli) for any subscription if you want to use the CLI to install packages from EDB repositories. The CLI works for all EDB repositories and is the most flexible way to install packages.

!!! Note
If you have a Standard or Community360 subscription, or want to install packages for Postgres Distributed without using TPA, you must use the CLI. Refer to the [CLI getting started guide](with_cli) for that.
If you have a Standard or Community360 subscription or want to install packages for Postgres Distributed without using TPA, you must use the CLI. See [Getting started using repositories with the CLI](with_cli).
!!!
9 changes: 4 additions & 5 deletions advocacy_docs/repos/getting_started/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ description: How to troubleshoot your repositories and downloads when they don't

If your download doesn't work, you can try the following troubleshooting steps:

* **Check your internet connection**: Make sure you are connected to the internet and that your connection is stable.
* **Check your internet connection.** Make sure you're connected to the internet and that your connection is stable.

* **Check for errors in the terminal**: If the curl command responded with an error or just returns immediately with no output, there may be an issue with the command. Check the command and try again.
* **Check for errors in the terminal.** If the curl command responded with an error or returns immediately with no output, there may be an issue with the command. Check the command and try again.

* **Check for 404 errors**: If you see a 404 error, its possible that your token doesn't entitle you to access the repository you have configured. Check the repository name and try again.

If none of these steps work, please contact [EDB Support](https://www.enterprisedb.com/support-center) for further assistance.
* **Check for 404 errors.** If you see a 404 error, it's possible that your token doesn't entitle you to access the repository you've configured. Check the repository name and try again.

If none of these steps work, contact [EDB Support](https://www.enterprisedb.com/support-center) for assistance.
Original file line number Diff line number Diff line change
@@ -1,41 +1,42 @@
---
title: Adding EDB repositories using the command line
navTitle: Adding EDB repositories
navTitle: Add EDB repositories
description: How to add EDB repositories to your system using the command line
---

Using the command line allows you more flexibility in adding EDB repositories to your system. The website currently only supports Enterprise subscriptions, but the CLI allows you to add any EDB repository, including `community360`, `standard`, `enterprise`, and `postgres_distributed`.
Using the command line to add repositories allows you more flexibility when adding EDB repositories to your system than using the website. The website currently supports only Enterprise subscriptions, but the CLI allows you to add any EDB repository, including `community360`, `standard`, `enterprise`, and `postgres_distributed`.

See the [Repositories by name](/repos/reference/repositories_by_name) page for more information and what subscriptions are able to access them.
See [Repositories by name](/repos/reference/repositories_by_name) for a list of repositories and the subscriptions that can access them.

1. Get your token. If you don't have a token, [get it now](get_your_token) and return to this page when you have your token.
1. From your EDB account, [get your token](get_your_token).

3. Save your token in the environment variable `$EDB_SUBSCRIPTION_TOKEN`:
1. Save your token in the environment variable `$EDB_SUBSCRIPTION_TOKEN`:

```bash
export EDB_SUBSCRIPTION_TOKEN=your_token_here
```

4. Save your required repository name in the environment variable `$EDB_REPO`:
1. Save your required repository name in the environment variable `$EDB_REPO`:

```bash
export EDB_REPO=your_repository_name_here
```

5. Depending on your operating system, run the following command:
1. Depending on your operating system, run the appropriate curl command.

**RHEL/AlmaLinux/RockyLinux/Oracle Linux and SUSE**:
**RHEL/AlmaLinux/RockyLinux/Oracle Linux and SUSE:**

```bash
curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_REPO/setup.rpm.sh" | sudo -E bash
```

**Ubuntu/Debian**:
**Ubuntu/Debian:**

```bash
curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_REPO/setup.deb.sh" | sudo -E bash
```

6. You can now install packages from that EDB repository. Move on to the [installing named packages](install_named_package) to install the packages you need.
1. You can now install packages from that EDB repository. Move on to [installing named packages](install_named_package) to install the packages you need.

7. If you have any issues, check the [troubleshooting](../troubleshooting) section.
!!! Note
If you have any issues, see [Troubleshooting](../troubleshooting).
22 changes: 11 additions & 11 deletions advocacy_docs/repos/getting_started/with_cli/get_your_token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,29 @@ navTitle: Get your token
description: How to get the token you need to download EDB software
---

## Tokens and EDB Accounts
## Tokens and EDB accounts

To download EDB software, you need a token.
This token is a string that identifies you and your eligibility to download software from EDB.
If you have an account on EDB, you have already have a token.
We'll show you how to retrieve it.
If you have an account on EDB, you already have a token and can retrieve it.

If you don't have an account, [sign up for a free EDB account](https://www.edbpostgres.com/accounts/register).
Signing up gives you a sixty-day trial subscription to EDB's software repositories.
Signing up gives you a 60-day trial subscription to EDB's software repositories.

## Getting your token

To get your token, you need use the web interface to the EDB Repositories. This is the only place where tokens are issued. Once you have your token, you'll be able to return to the CLI and complete your work there.
To get your Repos 2.0 token, use the web interface to the EDB repositories. This is the only place where tokens are issued. After you have your token, use the CLI to continue your work.

1. Go to the [EDB Repos 2.0](https://edbpostgres.com/repos-downloads) page, where you can obtain your Repos 2.0 token.
You may have to sign in to your EDB account to access this page. If you do have to sign in, you'll go to the account profile page. On the account profile page, select **Repo Access** to continue.
1. Go to the [EDB Repos 2.0](https://edbpostgres.com/repos-downloads) page.

2. You'll now be on the EDB Repositories page. On your first visit to this page, select **Request Access** to generate your Repos 2.0 token.
If you're not logged in, log in to your EDB account to access this page. After you log in, go to the Account Profile page. On the Account Profile page, select **Repo Access**.

3. Copy the token using the **Copy Token** icon, and store it safely.
1. On the EDB Repositories page, if it's your first visit, select **Request Access** to generate your Repos 2.0 token.

4. Once you’ve created your EDB account and generated your token, you can return to your CLI and configure your system to use the EDB repositories.
1. To copy the token to the clipboard, select the **Copy Token** icon. Then store the token safely.

The next step is to [add the EDB repositories to your system](adding_edb_repositories).
You can now use the CLI to configure your system to use the EDB repositories.

## Next step

Next, [add the EDB repositories to your system](adding_edb_repositories).
17 changes: 8 additions & 9 deletions advocacy_docs/repos/getting_started/with_cli/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting started using the CLI
navTitle: with the CLI
title: Getting started using repositories with the CLI
navTitle: With the CLI
description: How to download and install the EDB package you need using the CLI
navigation:
- get_your_token
Expand All @@ -9,13 +9,12 @@ navigation:
- troubleshooting
---

In this getting started section, you'll learn how to download and install the EDB package you need using the CLI. Using the CLI you can install from any EDB repository, including `community360`,`standard`,`enterprise`, and `postgres_distributed`.
This getting started describes how to use the CLI to download and install the EDB package you need. Using the CLI, you can install packages from any EDB repository, including `community360`, `standard`, `enterprise`, and `postgres_distributed`.

There are three steps to installing packages from EDB repositories using the CLI.
To install packages from EDB repositories using the CLI, you need to:

1. [Get your token](get_your_token)
2. [Add your repository](adding_edb_repositories)
3. [Install the package you need](install_named_package)

Once you've mastered package installation, you can move on to [working with repositories](../../working_with_repos) where you can learn how to directly browse repositories and download packages, create local mirrors, handle air-gapped installations, and integrate with configuration management tools.
1. [Get your token](get_your_token).
1. [Add your repository](adding_edb_repositories).
1. [Install the package you need](install_named_package).

Once you've mastered package installation, you can move on to [working with repositories](../../working_with_repos). Learn how to directly browse repositories and download packages, create local mirrors, handle air-gapped installations, and integrate with configuration management tools.
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,27 @@ navTitle: Installing a named package
description: How to install a named package from the EDB repository
---

1. Obtain the package name you want to install. You can find the package names through the EDB repository web interface. Package names are also listed in the [package names](/repos/reference/package_names) reference.
1. Obtain the package name you want to install. You can find the package names through the EDB repository web interface. Package names are also listed in the [Package names](/repos/reference/package_names) reference.

2. Run the following command to install the package, depending on your operating system:
1. Run the following command to install the package, depending on your operating system:

**RHEL/AlmaLinux/RockyLinux/Oracle Linux**:
**RHEL/AlmaLinux/RockyLinux/Oracle Linux:**

```bash
sudo dnf -y install package_name
```

**SUSE**:
**SUSE:**

```bash
sudo zypper install package_name
```

**Ubuntu/Debian**:
**Ubuntu/Debian:**

```bash
sudo apt-get -y install package_name
```

3. If you have any issues, check the [troubleshooting](../troubleshooting) section.

!!! Note
If you have any issues, see [Troubleshooting](../troubleshooting).
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
---
title: Add your repository
title: Add your repository using the web interface
navTitle: Add your repository
description: How to add the EDB repository to your system
---

You can add your repository using the web interface. (Alternatively, you can add the repository using the command line. See [Getting started using the CLE](../with_cli/).)

1. Navigate to [https://www.enterprisedb.com/repos-downloads](https://www.enterprisedb.com/repos-downloads). Sign in if required. If you do have to sign in, you'll go to the account profile page. On the account profile page, select **Repo Access** to continue.
1. Go to [https://www.enterprisedb.com/repos-downloads](https://www.enterprisedb.com/repos-downloads).

2. Select **Access Repos 2.0**.
If you're not already logged in, log in to your EDB account. Go to the Account Profile page. On the Account Profile page, select **Repo Access**.

3. On the next page, select the platform you wish to download packages to.
1. Select **Access Repos 2.0**.

4. Then select any software from the left hand list of EDB software.
1. On the next page, select the platform you want to download packages to.

5. On the right hand side, instructions appear for the installation of that particular software.
1. From the list of EDB software on the left side, select the software you want to add.

On the right side, instructions to install that software appear.

<img src="./images/step1.png" style="border:1px solid;margin: 1em auto 1em" alt="Repos 2.0 - Step 1" />

6. Go to **Step 1** and copy the Auto command. This is a ready-to-run repository installer for your system. Run alone, it only installs the EDB repositories for Repos 2.0. EDB's web site has already personalized the command by embedding your Repos token into the command, so you can run it as it.
1. Go to **Step 1** and copy the Auto command. This is a ready-to-run repository installer for your system. Run alone, it installs only the EDB repositories for Repos 2.0. EDB's website has already personalized the command by embedding your Repos token into the command, so you can run it as is.

7. Once complete, your system can download packages from EDB.
1. Paste the command into your terminal.

8. If you have any issues, check the [troubleshooting](../troubleshooting) section.
Once the operation is complete, your system can download packages from EDB.

!!! Note
If you have any issues, see [Troubleshooting](../troubleshooting).
24 changes: 11 additions & 13 deletions advocacy_docs/repos/getting_started/with_web/get_your_token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,27 @@ navTitle: Get your token
description: How to get the token you need to download EDB software
---

## Tokens and EDB Accounts
## Tokens and EDB accounts

To download EDB software, you need a token.
This token is a string that identifies you and your eligibility to download software from EDB.
If you have an account on EDB, your already have a token.
We'll show you how to retrieve it.
If you have an account on EDB, you already have a token and can retrieve it.

If you don't have an account, [sign up for a free EDB account](https://www.edbpostgres.com/accounts/register).
Signing up gives you a sixty-day trial subscription to EDB's software repositories.
Signing up gives you a 60-day trial subscription to EDB's software repositories.

## Getting your token

1. Go to the [EDB Repos 2.0](https://edbpostgres.com/repos-downloads) page, where you can obtain your Repos 2.0 token.
You may have to sign in to your EDB account to access this page. If you do have to sign in, you'll go to the account profile page.
On the account profile page, select **Repo Access** to continue.
1. Go to the [EDB Repos 2.0](https://edbpostgres.com/repos-downloads) page.

2. You will now be on the EDB Repositories page.
On your first visit to this page, select **Request Access** to generate your Repos 2.0 token.

3. Copy the token using the **Copy Token** icon, and store it safely.
If you're not already logged in, log in to your EDB account to access this page. After you log in, go to the Account Profile page. On the Account Profile page, select **Repo Access**.

4. Once you’ve created your EDB account and generated your token, you can go to [edbpostgres.com/downloads](https://edbpostgres.com/repos-downloads/) and configure your system to use the EDB repositories.
1. On the EDB Repositories page, if it's your first visit, select **Request Access** to generate your Repos 2.0 token.

The next step is to [add the EDB repository to your system](add_your_repository).
1. To copy the token to the clipboard, select the **Copy Token** icon. Then store the token safely.

After you create your EDB account and generate your token, you can go to [edbpostgres.com/downloads](https://edbpostgres.com/repos-downloads/) and configure your system to use the EDB repositories.

## Next step

Next, [add the EDB repository to your system](add_your_repository).
17 changes: 8 additions & 9 deletions advocacy_docs/repos/getting_started/with_web/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting started using repositories on the web
navTitle: with the web page
navTitle: With the web page
description: How to download and install the EDB package you need using the Repos page on the web
navigation:
- get_your_token
Expand All @@ -9,17 +9,16 @@ navigation:
- troubleshooting
---

To use this getting started section, you need to have an Enterprise subscription to EDB software. The web-based version of the repository system currently only supports Enterprise subscriptions.
To get started, you need to have an Enterprise subscription to EDB software. The web-based version of the repository system currently supports only Enterprise subscriptions.

!!! Note
If you want to install software from other EDB repositories, such as `community360` or `postgres_distributed`, you need to use the command line interface. Refer to the [CLI getting started guide](../with_cli) for that.
If you want to install software from other EDB repositories, such as `community360` or `postgres_distributed`, you need to use the command line interface. See [Getting started using repositories with the CLI](../with_cli).
!!!

There are three steps to installing packages from EDB repositories using the Web.
To install packages from EDB repositories using the web-based interface, you need to:

1. [Get your token](get_your_token)
2. [Add your repository](add_your_repository)
3. [Install the package you need](install_package)

Once you've mastered package installation, you can move on to [working with repositories](../../working_with_repos) where you can learn how to directly browse repositories and download packages, create local mirrors, handle air-gapped installations, and integrate with configuration management tools.
1. [Get your token](get_your_token).
1. [Add your repository](add_your_repository).
1. [Install the package you need](install_package).

Once you've mastered package installation, you can move on to [working with repositories](../../working_with_repos). Learn how to directly browse repositories and download packages, create local mirrors, handle air-gapped installations, and integrate with configuration management tools.
Loading

1 comment on commit 9444d7a

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.