NOTICE

Capybara is no longer in active development! It is advised to switch over to September <https://github.com/gemrest/september>_!

September's configuration (and experience) is nearly identical to Capybara's, so switching over should be no hassle.

Capybara

.. raw:: html

Synopsis

Capybara is an HTTP <https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol>__ to Gemini <https://gemini.circumlunar.space/>__ proxy designed to ... proxy ... Gemini capsules over to HTTP.

Capybara also happens to be a fork of Kineto <https://sr.ht/~sircmpwn/kineto/>__. If you think you don't need any of the modern day enhancements that Capybara offers, check out Kineto for a more bare, raw-er experience.

Usage

.. code-block:: shell

$ go build $ ./capybara [-b 127.0.0.1:8080] [-s style.css] [-e style.css] gemini://fuwn.me

:code:-b (:code:BIND)

The :code:`-b` argument is optional and allows you to bind to an arbitrary address;
by default Capybara will bind to :code:`:8080`. You should set up some external
reverse proxy like nginx to forward traffic to this port and add TLS.

:code:`-s` (:code:`CSS`)
~~~~~~~~~~~~~~~~~~~~~~~~

The :code:`-s` argument is optional and allows you to specify a custom CSS filename.
The given file will be loaded from the local disk and placed in a
:code:`<style>` block. By default Capybara will serve its built-in style.

:code:`-e` (:code:`CSS_EXTERNAL`)

The :code:-e argument is optional and allows you to specify a custom CSS URL. If provided, the style.css given will be treated as a link to be put in the href of a :code:<link rel="stylesheet"...> instead of being placed inline with the body in a :code:<style> block like with the :code:-s flag. The given stylesheet can be a relative link, for instance :code:-e /main.css will serve :code:main.css from the root of the proxied Gemini capsule.

Docker

.. code-block:: shell

$ docker run -d -e ROOT='gemini://fuwn.me' [-e BIND='127.0.0.1:8080'] [-e CSS='style.css'] [-e CSS_EXTERNAL='style.css'] fuwn/capybara

Docker Compose

Edit the :code:docker-compose.yml file to your liking, then...

.. code-block:: shell

$ 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

keep_gemini_exact: # A list of URLs where if the URL is present; the URL will not be proxied
  - fuwn.me/skills #
                   # Similar to `keep_gemini` except only keeps exact URLs

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

`GNU General Public License v3.0 <./LICENSE>`__