From 33a41b8fa1028e235d7bf5fbadf39615d2c1bee2 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 22 Jul 2021 11:20:42 +0200 Subject: fix(readme): docker compose example --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 78a055609686bdc654b5e9469954a02f5491937f Mon Sep 17 00:00:00 2001 From: Fuwn Date: Thu, 22 Jul 2021 16:38:36 +0200 Subject: chore(dockerfile): remove image disclaimer --- docker-compose.yml | 2 -- 1 file changed, 2 deletions(-) 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: -- cgit v1.2.3 From f7e22055159a990a88d23d2fb758d34f65c47bf0 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 22:59:18 -0700 Subject: feat(assets): upload logo --- Capybara_Logo_1000x1000.png | Bin 0 -> 42914 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 Capybara_Logo_1000x1000.png diff --git a/Capybara_Logo_1000x1000.png b/Capybara_Logo_1000x1000.png new file mode 100644 index 0000000..7e8a645 Binary files /dev/null and b/Capybara_Logo_1000x1000.png differ -- cgit v1.2.3 From dbbcc337947fe3c543a1825ac824b2da6ba29c7e Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:00:05 -0700 Subject: chore(assets): move capybara logo to assets folder --- assets/Capybara_Logo_1000x1000.png | Bin 0 -> 42914 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 assets/Capybara_Logo_1000x1000.png diff --git a/assets/Capybara_Logo_1000x1000.png b/assets/Capybara_Logo_1000x1000.png new file mode 100644 index 0000000..7e8a645 Binary files /dev/null and b/assets/Capybara_Logo_1000x1000.png differ -- cgit v1.2.3 From cf2d45614f9bc6d6a7d52317b2f40765824c012f Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:04:43 -0700 Subject: faet(readme): capybara logo --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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 c1d82f37d81aaaf9cf103ebb9f8d86018a49ebc0 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:05:08 -0700 Subject: chore(assets): delete leftover logo --- Capybara_Logo_1000x1000.png | Bin 42914 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Capybara_Logo_1000x1000.png diff --git a/Capybara_Logo_1000x1000.png b/Capybara_Logo_1000x1000.png deleted file mode 100644 index 7e8a645..0000000 Binary files a/Capybara_Logo_1000x1000.png and /dev/null differ -- cgit v1.2.3 From 19555f9ef1265c5312b8d1535983c0ce45b71949 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Fri, 13 Aug 2021 23:11:56 -0700 Subject: chore(readme): make it prettier --- README.rst | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) 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:`