Mikaela/Limnoria-doc
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria-doc.git synced 2024-12-27 13:42:33 +01:00
Code Issues Projects Releases Wiki Activity

Spelling, grammar and minor clarifications.

Browse Source 
Spelling: weather/whether.

Grammar: slight adjustments.

New content: Changed Apache to Apache httpd (the name of their server,
differentiates from the hundreds of other projects they have),
introduced Nginx at the same time and then split the two
configurations.  Added a note that other software may be able to be
used, but indicated sysadmins familiar with those packages should
configure them (they should be able to work it out from the existing
examples anyway).
This commit is contained in:
Ben McGinnes 2015-01-28 01:39:08 +11:00
parent e1f80be983
commit db402c8912
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
use/httpserver.rst
View File

@ -5,7 +5,7 @@ Using the HTTP server
Configuration
=============
The HTTP comes with a couple of additional variables:
The HTTP server comes with a couple of additional variables:
* :ref:`supybot.servers.http.favicon`: Path to the file which is shown to
browsers as favicon.
@ -14,9 +14,9 @@ The HTTP comes with a couple of additional variables:
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
* :ref:`supybot.servers.http.keepAlive`: Determines whether the HTTP server
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.
HTTPd might require changing 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).
@ -24,20 +24,22 @@ The HTTP comes with a couple of additional variables:
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).
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 one or more
subdirectories of its own.
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):
You may also want to run Apache httpd or Nginx in front of Supybot's HTTP
server, if you want to use subdomains or load balancing.
Here is an example of Apache httpd configuration (I didn't test it
with the rewrite, please notify me whether it works or not):
.. code-block:: apache
<VirtualHost 0.0.0.0:80>
ServerName stats.yourdomain.org
<Location />
ProxyPass http://localhost:8080/webstats/
ProxyPass HTTP://localhost:8080/webstats/
SetEnv force-proxy-request-1.0 1
SetEnv proxy-nokeepalive 1
RewriteEngine On
@ -45,7 +47,7 @@ not):
</Location>
</VirtualHost>
It's also possible to use Nginx in front of Supybot's HTTP server. Create a new site ``/etc/nginx/sites-enabled/bot``:
Here is an example of the Nginx configuration. Create a new site ``/etc/nginx/sites-enabled/bot``:
.. code-block:: nginx
@ -53,21 +55,28 @@ It's also possible to use Nginx in front of Supybot's HTTP server. Create a new
# Note that your default server should specify these ports
listen 80;
listen [::]:80;
# If your default server also has https configured, uncomment
# If your default server also has HTTPs configured, uncomment
# the following two listen lines to enable it for this vhost.
#listen 443;
#listen [::]:443;
server_name stats.yourdomain.org;
location / {
proxy_pass http://localhost:8080/;
proxy_pass HTTP://localhost:8080/;
}
}
Note that any HTTP server which can provide a reverse proxy service
can be configured to act as an intermediary or front end for the
Limnoria HTTP server. Configuring these alternatives is left as an
exercise to the system administrator (who ought to be familiar enough
with it already).
Templates
=========
Among plugins which use the http server, some use the standard templates
Among plugins which use the HTTP server, some use the standard templates
system which allows you to edit page templates in a standard way (for other
plugins, check their documentation).