diff options
| author | Fuwn <[email protected]> | 2021-08-24 05:07:12 +0000 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-08-24 05:07:12 +0000 |
| commit | a46f11548decba3fef24f501996962009266d07a (patch) | |
| tree | 6c30d47e31f4c96611445aa3f79faca8aa29ff15 | |
| parent | refactor(capybara): proxy to /proxy/ (prev: /x/) (diff) | |
| parent | fix(readme): capybara, not whirl (diff) | |
| download | capybara-a46f11548decba3fef24f501996962009266d07a.tar.xz capybara-a46f11548decba3fef24f501996962009266d07a.zip | |
Merge branch 'main' of https://github.com/fuwn/capybara
| -rw-r--r-- | README.rst | 50 | ||||
| -rw-r--r-- | assets/Capybara_Logo_1000x1000.png | bin | 0 -> 42914 bytes | |||
| -rw-r--r-- | docker-compose.yml | 2 |
3 files changed, 32 insertions, 20 deletions
@@ -1,11 +1,25 @@ Capybara ======== -This is an `HTTP <https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol>`__ -to `Gemini <https://gemini.circumlunar.space/>`__ proxy designed to provide -service for a single domain, i.e. to make your Gemini site available over HTTP. -It can proxy to any domain in order to facilitate linking to the rest of -Geminispace, but it defaults to a specific domain. +.. raw:: html + + <a href="https://github.com/fuwn/capybara"> + <img + src="https://raw.githubusercontent.com/fuwn/capybara/main/assets/Capybara_Logo_1000x1000.png" + alt="Capybara" + width="220"> + </a> + +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 ----- @@ -15,27 +29,27 @@ Usage $ go build $ ./capybara [-b 127.0.0.1:8080] [-s style.css] [-e style.css] gemini://fuwn.space --b -~~ +:code:`-b` (:code:`BIND`) +~~~~~~~~~~~~~~~~~~~~~~~~~ -The -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 +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. --s -~~ +:code:`-s` (:code:`CSS`) +~~~~~~~~~~~~~~~~~~~~~~~~ -The -s argument is optional and allows you to specify a custom CSS filename. +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. --e -~~ +:code:`-e` (:code:`CSS_EXTERNAL`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The -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 +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 -s flag. The given stylesheet can +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. @@ -44,7 +58,7 @@ Docker .. code-block:: shell - $ docker run -d [-b BIND='127.0.0.1:8080'] [-s CSS='style.css'] [-e CSS_EXTERNAL='style.css'] fuwn/capybara + $ docker run -d -e ROOT='gemini://fuwn.space' [-e BIND='127.0.0.1:8080'] [-e CSS='style.css'] [-e CSS_EXTERNAL='style.css'] fuwn/capybara Docker Compose -------------- diff --git a/assets/Capybara_Logo_1000x1000.png b/assets/Capybara_Logo_1000x1000.png Binary files differnew file mode 100644 index 0000000..7e8a645 --- /dev/null +++ b/assets/Capybara_Logo_1000x1000.png diff --git a/docker-compose.yml b/docker-compose.yml index ef7591a..86d3a8d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -# NOTE: There is no official Capybara Docker image *yet*. - version: "3.3" services: capybara: |