Refactor 1.0 docs with new toctree structure and inheritance

This commit is contained in:
Griatch 2022-02-06 19:27:15 +01:00
parent 62477eac50
commit 628afe9367
142 changed files with 3967 additions and 3024 deletions

View file

@ -1,35 +1,48 @@
# Server Setup and Life
This documentation covers how to setup and maintain the server, from first install to opening your game to the public.
This documentation covers how to setup and maintain the server,
from first install to opening your game to the public.
## Installation & running
- [Installation & Setup quick-start](./Installation.md) - one page to quickly get you going
- [Extended Install instructions](./Installation-Git.md) - if you have trouble or want to contribute to Evennia itself
- [Running through Docker](./Installation-Docker.md) - alternative install method, useful for quick deployment on remote servers
- [Installing Evennia on Android](./Installation-Android.md) - for those craving a mobile life
- [Controlling the server](./Start-Stop-Reload.md) - an extended view on how to start/stop/update the server
```{toctree}
:maxdepth: 2
## Installing custom game dirs
- [Installing Arxcode](../Contribs/Arxcode-Installation.md) - a custom gamedir based on the popular Evennia game [Arx](https://play.arxgame.org/)
Installation
Installation-Git
Installation-Docker
Installation-Troubleshooting
Installation-Android
Installation-Upgrade
Installation-Non-Interactive
Start-Stop-Reload
```
## Configuring
- [The settings file](./Settings-Default.md) - how and where to change the main settings of the server
- [Change database engine](./Choosing-An-SQL-Server.md) - if you want to use something other than SQLite3
- [Evennia game index](./Evennia-Game-Index.md) - register your upcoming game with the index to start the hype going
```{toctree}
:maxdepth: 2
Settings
Settings-Default
Choosing-An-SQL-Server
Evennia-Game-Index
IRC
Grapevine
RSS
How-to-connect-Evennia-to-Twitter
Client-Support-Grid
- [Chat on IRC](./IRC.md) - how to link your game's channels to an external [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) channel
- [Chat on Grapevine](./Grapevine.md) - how to link your game's channels the [Grapevine](https://grapevine.haus/) mud network/chat
- [Messages to RSS](./RSS.md) - have your game notify people through RSS
- [Messages to Twitter](./How-to-connect-Evennia-to-Twitter.md) - have Evennia send messages to [Twitter](https://twitter.com/) (requires some coding)
```
## Going public
- [Notes about security](./Security.md) - some things to think about to stay safe(r)
- [Using HAProxy](./HAProxy-Config.md) - putting a proxy in front of the game server for security
- [Using Apache as a webserver](./Apache-Config.md) - use Apache instead of Evennia's webserver (limited support)
- [Taking your server online](./Online-Setup.md) - decide on where to host and configure your game for production
- [Client support grid](./Client-Support-Grid.md) - clients known to work (or not) with Evennia
```{toctree}
:maxdepth: 2
Online-Setup
Security
HAProxy-Config
Apache-Config
```