Skip to content

Commit

Permalink
Merge pull request #5495 from EnterpriseDB/docs/pgd/fix/DOCS-350
Browse files Browse the repository at this point in the history
DOCS-350 - Improving PGD CLI install instructions
  • Loading branch information
djw-m authored Apr 23, 2024
2 parents db51d88 + e0fe2fb commit 25a40d0
Showing 1 changed file with 43 additions and 5 deletions.
48 changes: 43 additions & 5 deletions product_docs/docs/pgd/5/cli/installing_cli.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "Installing PGD CLI"
navTitle: "Installing PGD CLI"
deepToC: true
---

You can install PGD CLI on any system that can connect to the PGD cluster. To use PGD CLI, you need a user with PGD superuser privileges or equivalent. The PGD user with superuser privileges is the [bdr_superuser role](../security). An example of an equivalent user is edb_admin on an EDB BigAnimal distributed high-availability cluster.
Expand All @@ -13,22 +14,59 @@ By default, Trusted Postgres Architect installs and configures PGD CLI on each P

PGD CLI is installable from the EDB repositories, which you can access with your EDB account. PGD users and BigAnimal users, including those on a free trial, have an EDB account and access to PGD CLI.

These repositories require a token to enable downloads from them. To obtain your token, log in to [EDB Repos 2.0](https://www.enterprisedb.com/repos-downloads). If this is your first time visiting the EDB Repos 2.0 page, you must select **Request Access** to generate your token. Once a generated token is available, select the **Copy** icon to copy it to your clipboard, or select the eye icon to view it.
### Obtain your EDB subscription token

These repositories require a token to enable downloads from them. To obtain your token, log in to [EDB Repos 2.0](https://www.enterprisedb.com/repos-downloads). If this is your first time visiting the EDB Repos 2.0 page, you must select **Request Access** to generate your token. Once a generated token is available, select the **Copy** icon to copy it to your clipboard, or select the eye icon to view it.

### Set the EDB_SUBSCRIPTION_TOKEN environment variable
Once you have the token, execute the command shown for your operating system, substituting
your token for `<your-token>`.

### Add repository and install PGD CLI on Debian or Ubuntu
```
export EDB_SUBSCRIPTION_TOKEN=<your-token>
```

Then run the appropriate commands for your operating system:

### Install on Debian or Ubuntu

```bash
curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/postgres_distributed/setup.deb.sh' | sudo -E bash
curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/postgres_distributed/setup.deb.sh" | sudo -E bash
```

If this returns an error like `curl: (22) The requested URL returned error: 404`, check that you have entered the correct token.

When successful, you will see output like this:

```
Executing the setup script for the 'enterprisedb/postgres_distributed' repository ...
...
```

You can now install the PGD CLI package using the command:

```
sudo apt-get install edb-pgd5-cli
```

### Add repository and install PGD CLI on RHEL, Rocky, AlmaLinux, or Oracle Linux
### Install on RHEL, Rocky, AlmaLinux, or Oracle Linux

```bash
curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/postgres_distributed/setup.rpm.sh' | sudo -E bash
curl -1sSLf "https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/postgres_distributed/setup.rpm.sh" | sudo -E bash
```

If this returns an error like `curl: (22) The requested URL returned error: 404`, check that you have entered the correct token.

When successful, you will see output like this:

```
Executing the setup script for the 'enterprisedb/postgres_distributed' repository ...
...
```

You can now install the PGD CLI package using the command:

```
sudo yum install edb-pgd5-cli
```

Expand Down

1 comment on commit 25a40d0

@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.