From 318702156c77daf20bfa878949214411ac976443 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 22 Feb 2022 00:50:51 +0000 Subject: feat(#2): optionally, do not proxy url(s) If the user provides a `Capybara.yaml` with the `capybara.keep_gemini` key, do not proxy the provided values (URLs). Also implements a rudimentary configuration system for future extension. Thanks, @WellsBit! --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 392d2c2..f3b4bd0 100644 --- a/README.rst +++ b/README.rst @@ -69,6 +69,25 @@ Edit the :code:`docker-compose.yml` file to your liking, then... $ docker-compose up -d +Configuration +------------- + +Capybara allows the optional usage of a :code:`Capybara.yaml` file for simple configuration, here is the format: + +.. code-block:: yaml + + capybara: + keep_gemini: # A list of hosts where if the host is present; the URL will not be proxied + - fuwn.me # + # Example: + # Proxied: `gemini://gem.rest` becomes `/proxy/gem.rest` + # Not proxied (present in `capybara.keep_gemini`): `gemini://gem.rest` is kept + +The configuration file can be located in three different places relative to Capybara: + +- Docker Compose: :code:`./capybara-data/` +- Local: :code:`./` (same directory as the Capybara executable), :code:`./capybara/`, or :code:`./capybara-data/` + License ~~~~~~~ -- cgit v1.2.3