#+TITLE: Environment

#+begin_quote
The environment for pairing on Pair instances
#+end_quote

A refinement and replacement for the container and Pair related components of [[https://github.com/humacs/humacs][humacs/humacs]] (a configuration for Emacs + Doom-Emacs).
This environment is used when deployed in [[https://github.com/sharingio/pair][Pair]] instances.
It contains many useful utilities, humacs for it's Emacs configuration, and some useful general configuration.

Additional components include:
- [[./cmd/environment-exporter/][environment-exporter]] ::
  a webserver to export a list of processes that are listening on ports
- [[./cmd/environment-exposer/][environment-exposer]] ::
  a reconciler for creating Kubernetes Service and Ingress resources to map back to environment, based off of environment-exporter's data

** Variables
The following variables, when exported in the environment of a process that listens of UDP/TCP on all interfaces, will affect the way that processes are exposed using exporter/exposer on a Pair instance

   | Name                                    | Default             | Description                                                                  |
   |-----------------------------------------+---------------------+------------------------------------------------------------------------------|
   | =SHARINGIO_PAIR_EXPOSER_DISABLED=       | false               | disables the exporting of ports for the given process                        |
   | =SHARINGIO_PAIR_EXPOSER_HOSTNAME=       | process name + port | specifies a hostname for Ingresses, in place of the process name             |
   | =SHARINGIO_PAIR_EXPOSER_ALLOWED_PORTS=  |                     | a space-separated allow list of ports to expose from the given process       |
   | =SHARINGIO_PAIR_EXPOSER_DISABLED_PORTS= |                     | a space-separated disable list of ports to not expose from the given process |