mirror of
https://github.com/evennia/evennia.git
synced 2026-04-05 23:47:16 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
58f5ece91b
commit
1bbc93507a
1000 changed files with 39106 additions and 33861 deletions
|
|
@ -4,7 +4,8 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<title>Apache Config — Evennia 1.0-dev documentation</title>
|
||||
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
|
|
@ -37,7 +38,7 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="apache-config">
|
||||
<section id="apache-config">
|
||||
<h1>Apache Config<a class="headerlink" href="#apache-config" title="Permalink to this headline">¶</a></h1>
|
||||
<p><strong>Warning</strong>: This information is presented as a convenience, using another webserver than Evennia’s
|
||||
own is not directly supported and you are on your own if you want to do so. Evennia’s webserver
|
||||
|
|
@ -50,9 +51,9 @@ covered at the end of this page.</p>
|
|||
<p>Note that the Apache instructions below might be outdated. If something is not working right, or you
|
||||
use Evennia with a different server, please let us know. Also, if there is a particular Linux distro
|
||||
you would like covered, please let us know.</p>
|
||||
<div class="section" id="mod-wsgi-setup">
|
||||
<section id="mod-wsgi-setup">
|
||||
<h2><code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> Setup<a class="headerlink" href="#mod-wsgi-setup" title="Permalink to this headline">¶</a></h2>
|
||||
<div class="section" id="install-mod-wsgi">
|
||||
<section id="install-mod-wsgi">
|
||||
<h3>Install <code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code><a class="headerlink" href="#install-mod-wsgi" title="Permalink to this headline">¶</a></h3>
|
||||
<ul>
|
||||
<li><p><em>Fedora/RHEL</em> - Apache HTTP Server and <code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> are available in the standard package
|
||||
|
|
@ -71,15 +72,15 @@ $ apt-get install apache2 libapache2-mod-wsgi
|
|||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="copy-and-modify-the-vhost">
|
||||
</section>
|
||||
<section id="copy-and-modify-the-vhost">
|
||||
<h3>Copy and modify the VHOST<a class="headerlink" href="#copy-and-modify-the-vhost" title="Permalink to this headline">¶</a></h3>
|
||||
<p>After <code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> is installed, copy the <code class="docutils literal notranslate"><span class="pre">evennia/web/utils/evennia_wsgi_apache.conf</span></code> file to your
|
||||
apache2 vhosts/sites folder. On Debian/Ubuntu, this is <code class="docutils literal notranslate"><span class="pre">/etc/apache2/sites-enabled/</span></code>. Make your
|
||||
modifications <strong>after</strong> copying the file there.</p>
|
||||
<p>Read the comments and change the paths to point to the appropriate locations within your setup.</p>
|
||||
</div>
|
||||
<div class="section" id="restart-reload-apache">
|
||||
</section>
|
||||
<section id="restart-reload-apache">
|
||||
<h3>Restart/Reload Apache<a class="headerlink" href="#restart-reload-apache" title="Permalink to this headline">¶</a></h3>
|
||||
<p>You’ll then want to reload or restart apache2 after changing the configurations.</p>
|
||||
<ul>
|
||||
|
|
@ -94,15 +95,15 @@ modifications <strong>after</strong> copying the file there.</p>
|
|||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="enjoy">
|
||||
</section>
|
||||
<section id="enjoy">
|
||||
<h3>Enjoy<a class="headerlink" href="#enjoy" title="Permalink to this headline">¶</a></h3>
|
||||
<p>With any luck, you’ll be able to point your browser at your domain or subdomain that you set up in
|
||||
your vhost and see the nifty default Evennia webpage. If not, read the hopefully informative error
|
||||
message and work from there. Questions may be directed to our <a class="reference external" href="http://evennia.com">Evennia Community
|
||||
site</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="a-note-on-code-reloading">
|
||||
</section>
|
||||
<section id="a-note-on-code-reloading">
|
||||
<h3>A note on code reloading<a class="headerlink" href="#a-note-on-code-reloading" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If your <code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> is set up to run on daemon mode (as will be the case by default on Debian and
|
||||
Ubuntu), you may tell <code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> to reload by using the <code class="docutils literal notranslate"><span class="pre">touch</span></code> command on
|
||||
|
|
@ -111,8 +112,8 @@ changed, it will force a code reload. Any modifications to the code will not be
|
|||
live instance of your site until reloaded.</p>
|
||||
<p>If you are not running in daemon mode or want to force the issue, simply restart or reload apache2
|
||||
to apply your changes.</p>
|
||||
</div>
|
||||
<div class="section" id="further-notes-and-hints">
|
||||
</section>
|
||||
<section id="further-notes-and-hints">
|
||||
<h3>Further notes and hints:<a class="headerlink" href="#further-notes-and-hints" title="Permalink to this headline">¶</a></h3>
|
||||
<p>If you get strange (and usually uninformative) <code class="docutils literal notranslate"><span class="pre">Permission</span> <span class="pre">denied</span></code> errors from Apache, make sure
|
||||
that your <code class="docutils literal notranslate"><span class="pre">evennia</span></code> directory is located in a place the webserver may actually access. For example,
|
||||
|
|
@ -126,15 +127,15 @@ Not confirmed, but worth trying if there are trouble.</p>
|
|||
<span class="o"></</span><span class="n">Directory</span><span class="o">></span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="mod-proxy-and-mod-ssl-setup">
|
||||
</section>
|
||||
</section>
|
||||
<section id="mod-proxy-and-mod-ssl-setup">
|
||||
<h2><code class="docutils literal notranslate"><span class="pre">mod_proxy</span></code> and <code class="docutils literal notranslate"><span class="pre">mod_ssl</span></code> setup<a class="headerlink" href="#mod-proxy-and-mod-ssl-setup" title="Permalink to this headline">¶</a></h2>
|
||||
<p>Below are steps on running Evennia using a front-end proxy (Apache HTTP), <code class="docutils literal notranslate"><span class="pre">mod_proxy_http</span></code>,
|
||||
<code class="docutils literal notranslate"><span class="pre">mod_proxy_wstunnel</span></code>, and <code class="docutils literal notranslate"><span class="pre">mod_ssl</span></code>. <code class="docutils literal notranslate"><span class="pre">mod_proxy_http</span></code> and <code class="docutils literal notranslate"><span class="pre">mod_proxy_wstunnel</span></code> will simply be
|
||||
referred to as
|
||||
<code class="docutils literal notranslate"><span class="pre">mod_proxy</span></code> below.</p>
|
||||
<div class="section" id="install-mod-ssl">
|
||||
<section id="install-mod-ssl">
|
||||
<h3>Install <code class="docutils literal notranslate"><span class="pre">mod_ssl</span></code><a class="headerlink" href="#install-mod-ssl" title="Permalink to this headline">¶</a></h3>
|
||||
<ul>
|
||||
<li><p><em>Fedora/RHEL</em> - Apache HTTP Server and <code class="docutils literal notranslate"><span class="pre">mod_ssl</span></code> are available in the standard package
|
||||
|
|
@ -156,11 +157,11 @@ $ a2enmod ssl
|
|||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="tls-proxy-websocket-configuration">
|
||||
</section>
|
||||
<section id="tls-proxy-websocket-configuration">
|
||||
<h3>TLS proxy+websocket configuration<a class="headerlink" href="#tls-proxy-websocket-configuration" title="Permalink to this headline">¶</a></h3>
|
||||
<p>Below is a sample configuration for Evennia with a TLS-enabled http and websocket proxy.</p>
|
||||
<div class="section" id="apache-http-server-configuration">
|
||||
<section id="apache-http-server-configuration">
|
||||
<h4>Apache HTTP Server Configuration<a class="headerlink" href="#apache-http-server-configuration" title="Permalink to this headline">¶</a></h4>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><VirtualHost *:80>
|
||||
# Always redirect to https/443
|
||||
|
|
@ -195,8 +196,8 @@ $ a2enmod ssl
|
|||
</VirtualHost>
|
||||
</pre></div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="evennia-secure-websocket-configuration">
|
||||
</section>
|
||||
<section id="evennia-secure-websocket-configuration">
|
||||
<h4>Evennia secure websocket configuration<a class="headerlink" href="#evennia-secure-websocket-configuration" title="Permalink to this headline">¶</a></h4>
|
||||
<p>There is a slight trick in setting up Evennia so websocket traffic is handled correctly by the
|
||||
proxy. You must set the <code class="docutils literal notranslate"><span class="pre">WEBSOCKET_CLIENT_URL</span></code> setting in your <code class="docutils literal notranslate"><span class="pre">mymud/server/conf/settings.py</span></code> file:</p>
|
||||
|
|
@ -204,14 +205,14 @@ proxy. You must set the <code class="docutils literal notranslate"><span class="
|
|||
</pre></div>
|
||||
</div>
|
||||
<p>The setting above is what the client’s browser will actually use. Note the use of <code class="docutils literal notranslate"><span class="pre">wss://</span></code> is
|
||||
because our client will be communicating over an encrypted connection (“wss” indicates websocket
|
||||
because our client will be communicating over an encrypted connection (”wss” indicates websocket
|
||||
over SSL/TLS). Also, especially note the additional path <code class="docutils literal notranslate"><span class="pre">/ws</span></code> at the end of the URL. This is how
|
||||
Apache HTTP Server identifies that a particular request should be proxied to Evennia’s websocket
|
||||
port but this should be applicable also to other types of proxies (like nginx).</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
<div class="clearer"></div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue