From e2149c04611e256d25744372136bff95452fb72d Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 22 Jul 2021 11:20:42 +0000 Subject: fix(readme): docker compose example --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 6a435ad..0693d42 100644 --- a/README.rst +++ b/README.rst @@ -44,7 +44,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 -------------- -- cgit v1.2.3 From ff4bd3dc9ea948c404d8f82af3aa153ea028750c Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:04:43 +0000 Subject: faet(readme): capybara logo --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 0693d42..c6612c8 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,18 @@ Capybara ======== +.. raw:: html + + + Whirl + + +Synopsis +-------- + This is an `HTTP `__ to `Gemini `__ proxy designed to provide service for a single domain, i.e. to make your Gemini site available over HTTP. -- cgit v1.2.3 From 1f514373f926c9a3d8ac7a3f24df8cc8b0103b5d Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:11:56 +0000 Subject: chore(readme): make it prettier --- README.rst | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index c6612c8..5a1a4a7 100644 --- a/README.rst +++ b/README.rst @@ -13,11 +13,9 @@ Capybara Synopsis -------- -This is an `HTTP `__ -to `Gemini `__ 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. +Capybara is an `HTTP `__ +to `Gemini `__ proxy designed to ... proxy ... +Gemini capsules over to HTTP. Usage ----- @@ -27,27 +25,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:`