Skip to content

Commit

Permalink
Merge pull request #5272 from EnterpriseDB/release/2024-02-15c
Browse files Browse the repository at this point in the history
Release/2024-02-15c
  • Loading branch information
djw-m authored Feb 15, 2024
2 parents ad41f31 + eeb0d4a commit 79d321a
Show file tree
Hide file tree
Showing 21 changed files with 622 additions and 580 deletions.
56 changes: 27 additions & 29 deletions product_docs/docs/tpa/23/INSTALL-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,23 @@ originalFilePath: INSTALL-repo.md

---

This document explains how to use TPA from a copy of the source code
You can use TPA from a copy of the source code
repository.

!!! Note
EDB customers must [install TPA from packages](INSTALL/) in
order to receive EDB support for the software.
To receive EDB support for the software,
EDB customers must [install TPA from packages](INSTALL/).

To run TPA from source, you must install all of the dependencies
(e.g., Python 3.9+) that the packages would handle for you, or download
(for example, Python 3.9+) that the packages would handle for you. Or, download
the source and [run TPA in a Docker container](reference/INSTALL-docker/).
(Either way will work fine on Linux and macOS.)
(Either way works fine on Linux and macOS.)

## Quickstart

First, you must install the various dependencies Python 3, Python
venv, git, openvpn and patch. Installing from EDB repositories would
would install these automatically along with the TPA
First, you must install the various dependencies: Python 3, Python
venv, git, openvpn, and patch. Installing from EDB repositories
installs these for you along with the TPA
packages.

Before you install TPA, you must install the required packages:
Expand All @@ -32,35 +32,35 @@ Before you install TPA, you must install the required packages:

## Clone and setup

With prerequisites installed, you can now clone the repository.
After the prerequisites are installed, you can clone the repository:

```
git clone https://github.com/enterprisedb/tpa.git ~/tpa
```

This creates a `tpa` directory in your home directory.
Cloning creates a `tpa` directory in your home directory.

If you prefer to checkout with ssh use:<br/>
If you prefer to check out with SSH, use:

```
git clone ssh://[email protected]/EnterpriseDB/tpa.git ~/tpa
```

Add the bin directory, found within in your newly created clone, to your path with:
Add the bin directory to your path. You can find the bin directory in your newly created clone.

`export PATH=$PATH:$HOME/tpa/bin`
Add this line to your `.bashrc` file (or other profile file for your preferred shell):

Add this line to your `.bashrc` file (or other profile file for your preferred shell).
`export PATH=$PATH:$HOME/tpa/bin`

You can now create a working tpa environment by running:
You can now create a working TPA environment by running:

`tpaexec setup`

This will create the Python virtual environment that TPA will use in future. All needed packages are installed in this environment. To test this configured correctly, run the following:
This command creates the Python virtual environment that TPA will use in future. All needed packages are installed in this environment. To test whether this was configured correctly, run:

`tpaexec selftest`

You now have tpaexec installed.
tpaexec is now installed.

## Dependencies

Expand All @@ -69,7 +69,9 @@ You now have tpaexec installed.
TPA requires Python 3.9 or later, available on most
modern distributions. If you don't have it, you can use
[pyenv](https://github.com/pyenv/pyenv) to install any version of Python
you like without affecting the system packages.
you like without affecting the system packages. (If you weren't already using pyenv, add `pyenv` to
your PATH in `.bashrc`, and call `eval "$(pyenv init -)"` as described in
the [pyenv documentation](https://github.com/pyenv/pyenv#installation).)

```bash
# First, install pyenv and activate it in ~/.bashrc
Expand All @@ -92,23 +94,19 @@ $ python3 --version
3.9.0
```

If you were not already using pyenv, please remember to add `pyenv` to
your PATH in .bashrc and call `eval "$(pyenv init -)"` as described in
the [pyenv documentation](https://github.com/pyenv/pyenv#installation).

### Virtual environment options

By default, `tpaexec setup` will use the builtin Python 3 `-m venv`
to create a venv under `$TPA_DIR/tpa-venv`, and activate it
automatically whenever `tpaexec` is invoked.
By default, `tpaexec setup` uses the builtin Python 3 `-m venv`
to create a venv under `$TPA_DIR/tpa-venv` and activate it
whenever `tpaexec` is invoked.

You can run `tpaexec setup --venv /other/location` to specify a
different location for the new venv.

We strongly suggest sticking to the default venv location. If you use a
different location, you must also set the environment variable TPA_VENV
to its location, for example by adding the following line to your
.bashrc (or other shell startup scripts):
However, we strongly suggest leaving the default venv location. If you use a
different location, you must also set the environment variable `TPA_VENV`
to that location. For example, add the following line to your
`.bashrc` or other shell startup scripts:

```bash
export TPA_VENV="/other/location"
Expand Down
Loading

2 comments on commit 79d321a

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

πŸŽ‰ Published on https://edb-docs.netlify.app as production
πŸš€ Deployed on https://65ce49573573be158afdd9e9--edb-docs.netlify.app

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