evennia/docs/2.x/Setup/Setup-Overview.html
Evennia docbuilder action a4086236bc Updated HTML docs.
2023-06-10 08:12:58 +00:00

267 lines
No EOL
15 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Server Setup and Life &#8212; Evennia 2.x documentation</title>
<link rel="stylesheet" href="../_static/nature.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Installation" href="Installation.html" />
<link rel="prev" title="Updating Evennia" href="Updating-Evennia.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Installation.html" title="Installation"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="Updating-Evennia.html" title="Updating Evennia"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Server Setup and Life</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../index.html">
<img class="logo" src="../_static/evennia_logo.png" alt="Logo"/>
</a></p>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
<h3><a href="../index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Server Setup and Life</a><ul>
<li><a class="reference internal" href="#installation-and-running">Installation and running</a></li>
<li><a class="reference internal" href="#configuration">Configuration</a></li>
<li><a class="reference internal" href="#going-online">Going Online</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="Updating-Evennia.html"
title="previous chapter">Updating Evennia</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="Installation.html"
title="next chapter">Installation</a></p>
<div role="note" aria-label="source link">
<!--h3>This Page</h3-->
<ul class="this-page-menu">
<li><a href="../_sources/Setup/Setup-Overview.md.txt"
rel="nofollow">Show Page Source</a></li>
</ul>
</div><h3>Links</h3>
<ul>
<li><a href="https://www.evennia.com/docs/latest/index.html">Documentation Top</a> </li>
<li><a href="https://www.evennia.com">Evennia Home</a> </li>
<li><a href="https://github.com/evennia/evennia">Github</a> </li>
<li><a href="http://games.evennia.com">Game Index</a> </li>
<li>
<a href="https://discord.gg/AJJpcRUhtF">Discord</a> -
<a href="https://github.com/evennia/evennia/discussions">Discussions</a> -
<a href="https://evennia.blogspot.com/">Blog</a>
</li>
</ul>
<h3>Doc Versions</h3>
<ul>
<li><a href="Setup-Overview.html">2.x (main branch)</a></li>
<ul>
<li><a href="../1.3.0/index.html">1.3.0 (v1.3.0 branch)</a></li>
<li><a href="../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
</ul>
</div>
</div>
<div class="bodywrapper">
<div class="body" role="main">
<section class="tex2jax_ignore mathjax_ignore" id="server-setup-and-life">
<h1>Server Setup and Life<a class="headerlink" href="#server-setup-and-life" title="Permalink to this headline"></a></h1>
<p>This sums up all steps of maintaining your Evennia game from first installation to production release.</p>
<section id="installation-and-running">
<h2>Installation and running<a class="headerlink" href="#installation-and-running" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Git.html">Installing with GIT</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Docker.html">Installing with Docker</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Troubleshooting.html">Installation Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Android.html">Installing on Android</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Upgrade.html">Upgrading an existing installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Non-Interactive.html">Non-interactive setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="Running-Evennia.html">Start Stop Reload</a></li>
<li class="toctree-l1"><a class="reference internal" href="Updating-Evennia.html">Updating Evennia</a></li>
</ul>
</div>
</section>
<section id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Settings.html">Changing Game Settings</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Settings.html#settings-file">Settings file</a></li>
<li class="toctree-l2"><a class="reference internal" href="Settings.html#other-files-in-the-server-conf-directory">Other files in the <code class="docutils literal notranslate"><span class="pre">server/conf</span></code> directory</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Settings-Default.html">Evennia Default settings file</a></li>
<li class="toctree-l1"><a class="reference internal" href="Choosing-a-Database.html">Choosing a database</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Choosing-a-Database.html#sqlite3-default">SQLite3 (default)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-a-Database.html#postgresql">PostgreSQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-a-Database.html#mysql-mariadb">MySQL / MariaDB</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-a-Database.html#other-databases">Other databases</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Channels-to-Discord.html">Connect Evennia channels to Discord</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Discord.html#configuring-discord">Configuring Discord</a></li>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Discord.html#step-by-step-discord-setup">Step-By-Step Discord Setup</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Channels-to-Grapevine.html">Connect Evennia channels to Grapevine</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Grapevine.html#configuring-grapevine">Configuring Grapevine</a></li>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Grapevine.html#setting-up-grapevine-step-by-step">Setting up Grapevine, step by step</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Channels-to-IRC.html">Connect Evennia channels to IRC</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-IRC.html#configuring-irc">Configuring IRC</a></li>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-IRC.html#setting-up-irc-step-by-step">Setting up IRC, step by step</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Channels-to-RSS.html">Connect Evennia channels to RSS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-RSS.html#configuring-rss">Configuring RSS</a></li>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-RSS.html#setting-up-rss-step-by-step">Setting up RSS, step by step</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Channels-to-Twitter.html">Connect Evennia to Twitter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Twitter.html#configuring-twitter">Configuring Twitter</a></li>
<li class="toctree-l2"><a class="reference internal" href="Channels-to-Twitter.html#setting-up-twitter-step-by-step">Setting up Twitter, step by step</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="going-online">
<h2>Going Online<a class="headerlink" href="#going-online" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Evennia-Game-Index.html">Evennia Game Index</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Evennia-Game-Index.html#connect-with-the-wizard">Connect with the wizard</a></li>
<li class="toctree-l2"><a class="reference internal" href="Evennia-Game-Index.html#manual-settings">Manual Settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="Evennia-Game-Index.html#non-public-games">Non-public games</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Online-Setup.html">Online Setup</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#connecting-to-evennia-over-the-internet">Connecting to Evennia over the Internet</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#ssl-and-https">SSL and HTTPS</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#hosting-evennia-from-your-own-computer">Hosting Evennia from your own computer</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#hosting-evennia-on-a-remote-server">Hosting Evennia on a remote server</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#hosting-options-and-suggestions">Hosting options and suggestions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Client-Support-Grid.html">Client Support Grid</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Client-Support-Grid.html#client-grid">Client Grid</a></li>
<li class="toctree-l2"><a class="reference internal" href="Client-Support-Grid.html#workarounds-for-client-issues">Workarounds for client issues:</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Security-Practices.html">Security Hints and Practices</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#know-your-logs">Know your logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#disable-development-debugging-options">Disable development/debugging options</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#handle-user-uploaded-images-with-care">Handle user-uploaded images with care</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#disable-the-web-interface-if-you-only-want-telnet">Disable the web interface (if you only want telnet)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#change-your-ssh-port">Change your ssh port</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#set-up-a-firewall">Set up a firewall</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security-Practices.html#use-an-external-webserver-proxy">Use an external webserver / proxy</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Config-HAProxy.html">Configuring HAProxy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Config-HAProxy.html#getting-certificates">Getting certificates</a></li>
<li class="toctree-l2"><a class="reference internal" href="Config-HAProxy.html#installing-and-configuring-haproxy">Installing and configuring HAProxy</a></li>
<li class="toctree-l2"><a class="reference internal" href="Config-HAProxy.html#putting-it-all-together">Putting it all together</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Config-Nginx.html">Configuring NGINX for Evennia with SSL</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Config-Nginx.html#ssl-on-the-website-and-websocket">SSL on the website and websocket</a></li>
<li class="toctree-l2"><a class="reference internal" href="Config-Nginx.html#telnet-ssl">Telnet SSL</a></li>
<li class="toctree-l2"><a class="reference internal" href="Config-Nginx.html#dont-forget">Dont Forget!</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Config-Apache-Proxy.html">Configuring an Apache Proxy</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Config-Apache-Proxy.html#running-apache-as-a-proxy-in-front-of-evennia">Running Apache as a proxy in front of Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Config-Apache-Proxy.html#run-apache-instead-of-the-evennia-webserver">Run Apache instead of the Evennia webserver</a></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
</div>
</div>
</div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="Installation.html" title="Installation"
>next</a> |</li>
<li class="right" >
<a href="Updating-Evennia.html" title="Updating Evennia"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 2.x</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Server Setup and Life</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2023, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>