-
Notifications
You must be signed in to change notification settings - Fork 237
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5853 from EnterpriseDB/release-2024-07-12a
Release 2024-07-12a
- Loading branch information
Showing
38 changed files
with
760 additions
and
90 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Getting started with repositories | ||
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. | ||
|
||
* [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. | ||
|
||
!!! 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. | ||
!!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
title: Troubleshooting your repositories and downloads | ||
navTitle: Troubleshooting | ||
description: How to troubleshoot your repositories and downloads when they don't work | ||
--- | ||
|
||
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 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 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. | ||
|
41 changes: 41 additions & 0 deletions
41
advocacy_docs/repos/getting_started/with_cli/adding_edb_repositories.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Adding EDB repositories using the command line | ||
navTitle: Adding 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`. | ||
|
||
See the [Repositories by name](/repos/reference/repositories_by_name) page for more information and what subscriptions are able to 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. | ||
|
||
3. 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`: | ||
|
||
```bash | ||
export EDB_REPO=your_repository_name_here | ||
``` | ||
|
||
5. Depending on your operating system, run the following command: | ||
|
||
**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**: | ||
|
||
```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. | ||
|
||
7. If you have any issues, check the [troubleshooting](../troubleshooting) section. |
32 changes: 32 additions & 0 deletions
32
advocacy_docs/repos/getting_started/with_cli/get_your_token.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Get your token | ||
navTitle: Get your token | ||
description: How to get the token you need to download EDB software | ||
--- | ||
|
||
## 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 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. | ||
|
||
## 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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
3. Copy the token using the **Copy Token** icon, and store it safely. | ||
|
||
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. | ||
|
||
The next step is to [add the EDB repositories to your system](adding_edb_repositories). | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Getting started using the CLI | ||
navTitle: with the CLI | ||
description: How to download and install the EDB package you need using the CLI | ||
navigation: | ||
- get_your_token | ||
- add_your_repository | ||
- install_package | ||
- 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`. | ||
|
||
There are three steps to installing packages from EDB repositories using the CLI. | ||
|
||
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. | ||
|
30 changes: 30 additions & 0 deletions
30
advocacy_docs/repos/getting_started/with_cli/install_named_package.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: Installing a named package | ||
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. | ||
|
||
2. Run the following command to install the package, depending on your operating system: | ||
|
||
**RHEL/AlmaLinux/RockyLinux/Oracle Linux**: | ||
|
||
```bash | ||
sudo dnf -y install package_name | ||
``` | ||
|
||
**SUSE**: | ||
|
||
```bash | ||
sudo zypper install package_name | ||
``` | ||
|
||
**Ubuntu/Debian**: | ||
|
||
```bash | ||
sudo apt-get -y install package_name | ||
``` | ||
|
||
3. If you have any issues, check the [troubleshooting](../troubleshooting) section. | ||
|
25 changes: 25 additions & 0 deletions
25
advocacy_docs/repos/getting_started/with_web/add_your_repository.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Add your repository | ||
navTitle: Add your repository | ||
description: How to add the EDB repository to your system | ||
--- | ||
|
||
|
||
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. | ||
|
||
2. Select **Access Repos 2.0**. | ||
|
||
3. On the next page, select the platform you wish to download packages to. | ||
|
||
4. Then select any software from the left hand list of EDB software. | ||
|
||
5. On the right hand side, instructions appear for the installation of that particular software. | ||
|
||
<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. | ||
|
||
7. Once complete, your system can download packages from EDB. | ||
|
||
8. If you have any issues, check the [troubleshooting](../troubleshooting) section. | ||
|
32 changes: 32 additions & 0 deletions
32
advocacy_docs/repos/getting_started/with_web/get_your_token.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
title: Get your token | ||
navTitle: Get your token | ||
description: How to get the token you need to download EDB software | ||
--- | ||
|
||
## 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 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. | ||
|
||
## 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. | ||
|
||
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. | ||
|
||
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. | ||
|
||
The next step is to [add the EDB repository to your system](add_your_repository). | ||
|
||
|
3 changes: 3 additions & 0 deletions
3
advocacy_docs/repos/getting_started/with_web/images/step1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions
3
advocacy_docs/repos/getting_started/with_web/images/step2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Getting started using repositories on the web | ||
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 | ||
- add_your_repository | ||
- install_package | ||
- 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. | ||
|
||
!!! 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. | ||
!!! | ||
|
||
There are three steps to installing packages from EDB repositories using the Web. | ||
|
||
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. | ||
|
33 changes: 33 additions & 0 deletions
33
advocacy_docs/repos/getting_started/with_web/install_package.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
--- | ||
title: Installing Packages | ||
navTitle: Installing Packages | ||
description: How to install the EDB package you need | ||
--- | ||
|
||
Once you have added the EDB repository to your system, you can install any EDB package you need. | ||
|
||
## Finding the package name for the package you need. | ||
|
||
Installation instructions in the manuals for the EDB packages will tell you the package name you need to install. | ||
You can also look up the package name in the EDB Repos web page. | ||
|
||
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 be directed to the account profile page. On the account profile page, select **Repo Access** to continue. | ||
|
||
2. Select **Access Repos 2.0**. | ||
|
||
3. On the next page, select the platform you wish to download packages to. | ||
|
||
4. Then select any software from the left hand list of EDB software. | ||
|
||
5. On the right hand side, instructions appear for the installation of that particular software. Look for Step 2, the installation step. This is step 2 to install EDB Postgres Advanced Server version 16 on Ubuntu 22.04 on x86_64 | ||
|
||
<img src="./images/step2.png" alt="Repos 2.0 - Step 2" style="border: 1px solid; margin: 1em auto 1em;"/> | ||
|
||
6. The contents of **Step 2** show you the full installation command for the package. You can copy and paste this command into your terminal to install the package. If you just need the package name, that appears at the end of the command. | ||
|
||
If you have any issues, check the [troubleshooting](../troubleshooting) section. | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: EDB Repositories and Downloading | ||
navTitle: Repositories and Downloading | ||
directoryDefaults: | ||
iconName: Download | ||
indexCards: simple | ||
prevNext: true | ||
navigation: | ||
- getting_started | ||
- working_with_repos | ||
- migration | ||
- reference | ||
redirects: | ||
- /purl/repos/docs | ||
--- | ||
|
||
Head to [Getting Started](getting_started) if you want to start installing right now. | ||
|
||
|
||
Efficient distribution and installation of software is key to a successful system deployment. At EDB we create our software packages with this in mind and distribute it to you through platform specific package managers. For most purposes, following the instructions from the download portal enables you to quickly configure your operating system to also download software from the EDB repository. Once you have done this, your system can install any EDB package you need. | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
048f492
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π Published on https://edb-docs.netlify.app as production
π Deployed on https://66914bb6ea1719441fc5f2ef--edb-docs.netlify.app
048f492
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
π Published on https://edb-docs-staging.netlify.app as production
π Deployed on https://669151bc1d920c07dac59dee--edb-docs-staging.netlify.app