Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-19 14:26:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
evennia/docs/1.0-dev/Setup/Setup-Overview.html
Evennia docbuilder action ff8c0351a9 Updated HTML docs
2022-08-28 13:01:56 +00:00

299 lines
No EOL
19 KiB
HTML
Raw Blame History

<!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 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" />
<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="Evennia Introduction" href="../Evennia-Introduction.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="../Evennia-Introduction.html" title="Evennia Introduction"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Server Setup and Life</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="document">
<div class="documentwrapper">
<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 documentation covers how to setup and maintain the server,
from first install to opening your game to the public.</p>
<section id="installation-running">
<h2>Installation &amp; running<a class="headerlink" href="#installation-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><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#initialize-a-new-game">Initialize a new game</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#start-the-new-game">Start the new game</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#restarting-and-stopping">Restarting and stopping</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#see-server-logs">See server logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#server-configuration">Server configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#register-with-the-evennia-game-index-optional">Register with the Evennia Game Index (optional)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#the-next-steps">The Next steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Git.html">Installing with GIT</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#summary">Summary</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#linux-install">Linux Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#mac-install">Mac Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Git.html#windows-install">Windows Install</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Docker.html">Installing with Docker</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#running-your-game-as-a-docker-image">Running your game as a docker image</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#create-your-own-game-image">Create your own game image</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#how-it-works">How it Works</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Docker.html#additional-creature-comforts">Additional Creature Comforts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Troubleshooting.html">Installation Troubleshooting</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#check-your-requirements">Check your Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#confusion-of-location-git-installation">Confusion of location (GIT installation)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#virtualenv-setup-fails">Virtualenv setup fails</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#localhost-not-found">Localhost not found</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#linux-troubleshooting">Linux Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#mac-troubleshooting">Mac Troubleshooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Troubleshooting.html#windows-troubleshooting">Windows Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Android.html">Installing on Android</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#install-termux">Install Termux</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#running-evennia">Running Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#caveats">Caveats</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation-Android.html#troubleshooting">Troubleshooting</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Installation-Upgrade.html">Upgrading an existing installation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Installation-Upgrade.html#evennia-v0-9-5-to-1-0">Evennia v0.9.5 to 1.0</a></li>
</ul>
</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="Start-Stop-Reload.html">Start Stop Reload</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#starting-evennia">Starting Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#foreground-mode">Foreground mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#reloading">Reloading</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#resetting">Resetting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#rebooting">Rebooting</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#shutting-down">Shutting down</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#status-and-info">Status and info</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#killing-linux-mac-only">Killing (Linux/Mac only)</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#django-options">Django options</a></li>
<li class="toctree-l2"><a class="reference internal" href="Start-Stop-Reload.html#advanced-handling-of-evennia-processes">Advanced handling of Evennia processes</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="configuring">
<h2>Configuring<a class="headerlink" href="#configuring" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Settings.html">Game Settings and Configuration direcotry</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-An-SQL-Server.html">Choosing An SQL Server</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Choosing-An-SQL-Server.html#sqlite3">SQLite3</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-An-SQL-Server.html#postgresql">PostgreSQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-An-SQL-Server.html#mysql-mariadb">MySQL / MariaDB</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-An-SQL-Server.html#add-mysql-configuration-to-evennia">Add MySQL configuration to Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-An-SQL-Server.html#others">Others</a></li>
</ul>
</li>
<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="IRC.html">IRC</a><ul>
<li class="toctree-l2"><a class="reference internal" href="IRC.html#configuring-irc">Configuring IRC</a></li>
<li class="toctree-l2"><a class="reference internal" href="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="Grapevine.html">Grapevine</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Grapevine.html#configuring-grapevine">Configuring Grapevine</a></li>
<li class="toctree-l2"><a class="reference internal" href="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="RSS.html">RSS</a><ul>
<li class="toctree-l2"><a class="reference internal" href="RSS.html#configuring-rss">Configuring RSS</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="How-to-connect-Evennia-to-Twitter.html">How to connect Evennia to Twitter</a><ul>
<li class="toctree-l2"><a class="reference internal" href="How-to-connect-Evennia-to-Twitter.html#configuring-twitter">Configuring Twitter</a></li>
<li class="toctree-l2"><a class="reference internal" href="How-to-connect-Evennia-to-Twitter.html#install-the-twitter-python-module">Install the twitter python module</a></li>
<li class="toctree-l2"><a class="reference internal" href="How-to-connect-Evennia-to-Twitter.html#a-basic-tweet-command">A basic tweet command</a></li>
<li class="toctree-l2"><a class="reference internal" href="How-to-connect-Evennia-to-Twitter.html#next-steps">Next Steps</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>
</ul>
</div>
</section>
<section id="going-public">
<h2>Going public<a class="headerlink" href="#going-public" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<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-from-the-outside">Connecting from the outside</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#ssl">SSL</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#relevant-ssl-proxy-setup-information">Relevant SSL Proxy Setup Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#hosting-locally-or-remotely">Hosting locally or remotely?</a></li>
<li class="toctree-l2"><a class="reference internal" href="Online-Setup.html#cloud9">Cloud9</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Security.html">Security</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Security.html#know-your-logs">Know your logs</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security.html#disable-development-debugging-options">Disable development/debugging options</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security.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.html#disable-the-web-interface">Disable the web interface</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security.html#change-your-ssh-port">Change your ssh port</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security.html#set-up-a-firewall">Set up a firewall</a></li>
<li class="toctree-l2"><a class="reference internal" href="Security.html#use-an-external-webserver">Use an external webserver</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="HAProxy-Config.html">Making Evennia, HTTPS and WSS (Secure Websockets) play nicely together</a><ul>
<li class="toctree-l2"><a class="reference internal" href="HAProxy-Config.html#getting-certificates">Getting certificates</a></li>
<li class="toctree-l2"><a class="reference internal" href="HAProxy-Config.html#installing-and-configuring-haproxy">Installing and configuring HAProxy</a></li>
<li class="toctree-l2"><a class="reference internal" href="HAProxy-Config.html#putting-it-all-together">Putting it all together</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Apache-Config.html">Apache Config</a><ul>
<li class="toctree-l2"><a class="reference internal" href="Apache-Config.html#mod-wsgi-setup"><code class="docutils literal notranslate"><span class="pre">mod_wsgi</span></code> Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="Apache-Config.html#mod-proxy-and-mod-ssl-setup"><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></li>
</ul>
</li>
</ul>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<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>
<p><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-running">Installation &amp; running</a></li>
<li><a class="reference internal" href="#configuring">Configuring</a></li>
<li><a class="reference internal" href="#going-public">Going public</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="../Evennia-Introduction.html"
title="previous chapter">Evennia Introduction</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">Home page</a> </li>
<li><a href="https://github.com/evennia/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>Versions</h3>
<ul>
<li><a href="Setup-Overview.html">1.0-dev (develop 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="clearer"></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="../Evennia-Introduction.html" title="Evennia Introduction"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Server Setup and Life</a></li>
</ul>
<div class="develop">develop branch</div>
</div>
<div class="footer" role="contentinfo">
&#169; Copyright 2020, The Evennia developer community.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.2.1.
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink