about summary refs log tree commit homepage
path: root/lib/yahns.rb
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-05-10 02:30:29 +0000
committerEric Wong <e@80x24.org>2019-05-10 02:30:29 +0000
commit995eefdf9f09f1a4621e3aab0184c5ae2787ca0c (patch)
treed806646312d2d3a14fce975cc24bb8a55d470d47 /lib/yahns.rb
parent2ca6808f7d91b1dd44cd5b6eb31e9b272d865891 (diff)
downloadyahns-995eefdf9f09f1a4621e3aab0184c5ae2787ca0c.tar.gz
Might as well... this has been in use at YHBT.net for ~4 years
at this point.  And given nginx has new corporate overlords,
maybe a decidedly non-enterprisey alternative is worth
"marketing" :P

Previous discussion from 2016:
https://YHBT.net/yahns-public/20160220081619.GA10850@dcvr.yhbt.net/
Diffstat (limited to 'lib/yahns.rb')
-rw-r--r--lib/yahns.rb17
1 files changed, 10 insertions, 7 deletions
diff --git a/lib/yahns.rb b/lib/yahns.rb
index 08945ef..4cf911e 100644
--- a/lib/yahns.rb
+++ b/lib/yahns.rb
@@ -1,5 +1,5 @@
-# Copyright (C) 2013-2016 all contributors <yahns-public@yhbt.net>
-# License: GPL-3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2013-2019 all contributors <yahns-public@yhbt.net>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 # frozen_string_literal: true
 $stdout.sync = $stderr.sync = true
 
@@ -16,12 +16,15 @@ require 'io/wait'
     Unicorn.__send__(:remove_const, sym) if Unicorn.const_defined?(sym)
 end
 
-# yahns exposes no user-visible API outside of the config file.
-# See https://yhbt.net/yahns.git/tree/examples/yahns_config.txt
-# for the config documentation
+# yahns exposes little user-visible API outside of the config file.
+# See https://yhbt.net/yahns/yahns_config.txt
+# for the config documentation (or yahns_config(5) manpage)
 # and https://yhbt.net/yahns.git/about/ for the homepage.
-# Internals are subject to change.
-
+#
+# Yahns::ProxyPass is currently the only public API.
+#
+# Documented APIs and options are supported forever,
+# internals are subject to change.
 module Yahns
   # :stopdoc:
   # We populate this at startup so we can figure out how to reexecute