Installing TPA from source
==========================

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

..  Note::
   EDB customers must  :ref:`TPA installation <TPA installation>`  in order to receive EDB support for the software.

To run TPA from source, you must install all of the dependencies (e.g.,
Python 3.12+) that the packages would handle for you, or download the
source and :ref:`Running TPA in a Docker container <Running TPA in a Docker container>`  . (Either way will work fine on Linux and
macOS.)

Quickstart
----------

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

Before you install TPA, you must install the required packages:

- **Debian/Ubuntu**
  ``sudo apt-get install python3 python3-pip python3-venv git openvpn``

- **Redhat, Rocky or AlmaLinux (RHEL7)**
  ``sudo yum install python3 python3-pip epel-release git openvpn``

- **Redhat, Rocky or AlmaLinux (RHEL8)**
  ``sudo yum install python36 python3-pip epel-release git openvpn``

Clone and setup
---------------

With prerequisites installed, you can now clone the repository.

.. code:: shell

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

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

If you prefer to checkout with ssh use:

.. code:: shell

   git clone ssh://git@github.com/EnterpriseDB/tpa.git ~/tpa

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

.. code:: shell

   export PATH=$PATH:$HOME/tpa/bin

Add this line to your ``.bashrc`` file (or other profile file for your
preferred shell).

You can now create a working tpa environment by running:

.. code:: shell

   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:

.. code:: shell

   tpaexec selftest

You now have tpaexec installed.

Dependencies
------------

Python 3.12+
^^^^^^^^^^^^

TPA requires Python 3.12 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.

.. code:: shell


   #  First, install pyenv and activate it in ~/.bashrc

   #  See https://github.com/pyenv/pyenv#installation

   #  (e.g., `brew install pyenv` on MacOS X)

   pyenv install 3.12.0

.. code:: output

   Downloading Python-3.12.0.tar.xz...
   - > https://www.python.org/ftp/python/3.12.0/Python-3.12.0.tar.xz
   Installing Python-3.12.0...
   Installed Python-3.12.0 to /home/ams/.pyenv/versions/3.12.0

.. code:: shell

   pyenv local 3.12.0
   pyenv version

.. code:: output

   3. 12.0 (set by /home/ams/pyenv/.python-version)

.. code:: shell

   pyenv which python3

.. code:: output

   /home/ams/.pyenv/versions/3.12.0/bin/python3

.. code:: shell

   python3 --version

.. code:: output

   3. 12.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.

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):

.. code:: shell

   export TPA_VENV="/other/location"