https://github.com/sharingio/environment
A containerised environment with many tools useful for Pairing
https://github.com/sharingio/environment
docker emacs emacs-lisp golang humacs pair-programming sharingio-pair
Last synced: about 2 months ago
JSON representation
A containerised environment with many tools useful for Pairing
- Host: GitHub
- URL: https://github.com/sharingio/environment
- Owner: sharingio
- Created: 2021-06-03T04:30:30.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-29T20:10:19.000Z (over 3 years ago)
- Last Synced: 2025-01-19T13:26:23.615Z (over 1 year ago)
- Topics: docker, emacs, emacs-lisp, golang, humacs, pair-programming, sharingio-pair
- Language: Go
- Size: 154 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.org
Awesome Lists containing this project
README
#+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 |