~arsen/vengor

2f603aeb8cfea3baeb5c04d397f4a4d18145c1e0 — Arsen Arsenović 6 months ago 632a2d3
readme: add more valuable information
1 files changed, 52 insertions(+), 1 deletions(-)

M README.rst
M README.rst => README.rst +52 -1
@@ 2,6 2,57 @@ vengor
======
Vendors a Go package.

Installation and administration
-------------------------------
Vengor can be installed like any other Python package, via :code:`pip`.

Vengor is a WSGI app which produces calls to a Huey_ consumer.
This extra service is necessary due to the unfortunate nature of WSGI and, more
broadly, multithreading in Python.

While I do development and deployment on gunicorn_, the service not working on
any given WSGI server is considered a bug.
Please do report any issues of this nature.

See the provided :code:`vengor-huey_consumer.service`,
:code:`vengor-gunicorn.socket` and :code:`vengor-gunicorn.service` units
for an example of how to run Vengor.

.. _gunicorn: https://gunicorn.org/
.. _Huey: https://huey.readthedocs.io/

Configuration
^^^^^^^^^^^^^
Vengor recognizes some environment variables:

VENGOR_HUEY_FILE
  Path to the Huey SQLite database.
  Make sure that this value is equal across the WSGI app and Huey consumer.

VENGOR_DEBUG
  If non null and nonempty, sets the Vengor logger level to DEBUG.

VENGOR_DATASTORE
  Path to the directory in which to cache results.
  Make sure that this value is equal across the WSGI app and Huey consumer.

GOPROXY
  Vengor uses Go module proxies for version query resolution.
  Make sure that this value is equal across the WSGI app and Huey consumer.
  It will also forcefully prefix this value with :code:`https`.
  Defaults to :code:`proxy.golang.org`.

Contributing and reporting issues
---------------------------------
Reach out to `my mailing list`_, please prefix your subject line with
:code:`Vengor:` and use :code:`format.subjectprefix = PATCH Vengor` for
patches.

.. _`my mailing list`: https://lists.sr.ht/~arsen/public-inbox

License
=======
-------
GNU Affero General Public License, version 3 only.

..
   vim: sw=2 et :