Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-04-02 05:57:16 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated HTML docs.

Browse source
This commit is contained in:
Evennia docbuilder action 2022-11-22 17:04:56 +00:00
parent 1ae614d35e
commit a6076aff42
65 changed files with 878 additions and 1146 deletions
Download patch file Download diff file Expand all files Collapse all files

90
docs/1.0-dev/Setup/Setup-Overview.html
View file

@ -113,6 +113,8 @@
<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#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="Installation.html#install-with-pip">Install with <code class="docutils literal notranslate"><span class="pre">pip</span></code></a></li>
<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>
@ -180,50 +182,38 @@
<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">Game Settings and Configuration directory</a><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-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>
<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">SQLite3</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#add-mysql-configuration-to-evennia">Add MySQL configuration to Evennia</a></li>
<li class="toctree-l2"><a class="reference internal" href="Choosing-a-Database.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>
<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="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>
<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="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>
<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="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>
<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>
@ -233,33 +223,39 @@
<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="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-across-the-internet">Connecting to Evennia across the Internet</a></li>
<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="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>
<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="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>
<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="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>
<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>
</ul>