From 625d6939ce05681a34198a7743d0d2514d289f11 Mon Sep 17 00:00:00 2001 From: Mikaela Suomalainen Date: Sun, 27 Jul 2014 15:03:12 +0300 Subject: [PATCH] use/httpserver.rst: multiple updates * Update config variables * add favicon * host is nowadays known as hosts4 * add hosts6 * move keepalive above port as that is how it appears in the bot too * specify that HTTPd might require port change, not HTTP * HTTPd might not work if port is too low = port is under 1024 * Apache is in front of Supybot's HTTPd, not behind. --- use/httpserver.rst | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/use/httpserver.rst b/use/httpserver.rst index ffc0e11..eda6d00 100644 --- a/use/httpserver.rst +++ b/use/httpserver.rst @@ -7,14 +7,19 @@ Configuration The HTTP comes with a couple of additional variables: -* :ref:`supybot.servers.http.host`: The host the bot will bind. In most of - the cases, you will use 0.0.0.0 (everything) or 127.0.0.1 (restricted to - local connections). Defaults to 0.0.0.0 -* :ref:`supybot.servers.http.port`: The port the bot will bind. May not work - if the number is too low. Defaults to 8080 (alternative HTTP port). +* :ref:`supybot.servers.http.favicon`: Path to the file which is shown to + browsers as favicon. +* :ref:`supybot.servers.http.hosts4`: The IPv4 addresses where the bot + will bind. In most of the cases, you will use 0.0.0.0 (everything) or + 127.0.0.1 (restricted to local connections). Defaults to 0.0.0.0 +* :ref:`supybot.servers.http.hosts6`: The IPv6 addresses where the bot + will bind. Defaults to empty. * :ref:`supybot.servers.http.keepAlive`: Determines weather the HTTP server - will run even if has nothing to serve. Defaults to False, because the HTTP - might require to change the port, if it is already taken. + will run even if has nothing to serve. Defaults to False, because the + HTTPd might require to change the port, if it is already taken. +* :ref:`supybot.servers.http.port`: The port the bot will bind. May not + work if the number is below 1024. Defaults to 8080 (alternative HTTP port). + Using the server ================ @@ -22,15 +27,16 @@ Using the server At the root of the server, you will find a list of the plugins that have a Web interface, and a link to them. Each plugin has its own subdirectory(ies). -You may also want to have Apache behind Supybot's HTTP server, if you want to -use subdomains. Here is an example of configuration (I didn't test it with the -rewrite, please notify me whether it works or not): +You may also want to have Apache in front of Supybot's HTTP server, if +you want to use subdomains. Here is an example of configuration +(I didn't test it with the rewrite, please notify me whether it works or +not): .. code-block:: apache ServerName stats.yourdomain.org - + ProxyPass http://localhost:8080/webstats/ SetEnv force-proxy-request-1.0 1 SetEnv proxy-nokeepalive 1