diff --git a/docs/source/Setup/Getting-Started.md b/docs/source/Setup/Extended-Installation.md similarity index 100% rename from docs/source/Setup/Getting-Started.md rename to docs/source/Setup/Extended-Installation.md diff --git a/docs/source/Setup/HAProxy-Config-(Optional).md b/docs/source/Setup/HAProxy-Config.md similarity index 95% rename from docs/source/Setup/HAProxy-Config-(Optional).md rename to docs/source/Setup/HAProxy-Config.md index 0984839467..daaebc6e83 100644 --- a/docs/source/Setup/HAProxy-Config-(Optional).md +++ b/docs/source/Setup/HAProxy-Config.md @@ -1,7 +1,8 @@ # HAProxy Config (Optional) ### Evennia, HTTPS and Secure Websockets can play nicely together, quickly. -May I suggest giving HAProxy 1.5+ a chance... + +This sets up HAProxy 1.5+ in front of Evennia to provide security. Installing HAProxy is usually as simple as: ``` @@ -58,4 +59,4 @@ LOCKDOWN_MODE=True and ``` WEBSOCKET_CLIENT_URL="wss://yourhost.com:4002/" -``` \ No newline at end of file +``` diff --git a/docs/source/evennia-api.md.py b/docs/source/Setup/Settings-File.md similarity index 100% rename from docs/source/evennia-api.md.py rename to docs/source/Setup/Settings-File.md diff --git a/docs/source/Setup/Setup-Overview.md b/docs/source/Setup/Setup-Overview.md index 7e4de7e217..360f751fe4 100644 --- a/docs/source/Setup/Setup-Overview.md +++ b/docs/source/Setup/Setup-Overview.md @@ -1,50 +1,35 @@ -# Setup and maintenance +# Server Setup -The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the -server doesn't make anything visible online. Once you download everything you can in fact develop your game -in complete isolation if you want, without needing any access to the internet. +This documentation covers how to setup and maintain the server, from first install to opening your game to the public. -## Installation +## Installation & running -Evennia requires Python3.7+. As with most Python packages, using a -[virtualenv](../Glossary#Virtualenv) is recommended in order to keep your -installation independent from the system libraries. +- [Installation & Setup quick-start](Setup-Quickstart) - one page to quickly get you going +- [Extended Install instructions](Extended-Installation) - if you have trouble or want to contribute to Evennia itself +- [Running through Docker](Running-Evennia-in-Docker) - alternative install method, useful for quick deployment on remote servers +- [Installing Evennia on Android](Installing-on-Android) - for those craving a mobile life +- [Controlling the server](Start-Stop-Reload) - an extended view on how to start/stop/update the server - pip install evennia +## Installing custom game dirs -If things worked, the `evennia` command should now be available. +- [Installing Arxcode](Arxcode-installing-help) - a custom gamedir based on the popular Evennia game [Arx](https://play.arxgame.org/) -If you are having trouble or want to help develop Evennia itself, check out the -[Extended Installation instructions](Setup/Extended-Installation). It also has -a [troubleshooting section](Setup/Extended-Installation#Troubleshooting) for -different operating systems. +## Configuring -## Initialize a new game - -Use `cd` to enter a folder where you want to do your game development. Here (and in -the rest of this documentation we call this folder `mygame`, but you should of course -name your game whatever you like): - - evennia --init mygame - -This will create a new folder `mygame` (or whatever you chose) in your current location. This -contains +- [The settings file](Settings-File) - how and where to change the main settings of the server +- [Change database engine](Choosing-An-SQL-Server) - if you want to use something other than SQLite3 +- [Evennia game index](Evennia-Game-Index) - register your upcoming game with the index to start the hype going -## Start your new game +- [Chat on IRC](IRC) - how to link your game's channels to an external [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) channel +- [Chat on Grapevine](Grapevine) - how to link your game's channels the [Grapevine](https://grapevine.haus/) mud network/chat +- [Messages to RSS](RSS) - have your game notify people through RSS +- [Messages to Twitter](How-to-connect-Evennia-to-Twitter) - have Evennia send messages to [Twitter](https://twitter.com/) (requires some coding) -`cd` into your game folder (`mygame` above). Next run +## Going public - evennia migrate - -This will create the default database (Sqlite3). The database file ends up as `mygame/server/evennia.db3`. If you -ever want to start from a fresh database, just delete this file and re-run `evennia migrate` again. - - evennia start - -Fill in your user-name and password. This will be the "god user" or "superuser" in-game. The email is optional. - -If all went well, the server is now up and running. Point a legacy MUD/telnet client to `localhost:4000` or -a web browser at [http://localhost:4001](http://localhost:4001) to play your new (if empty) game! - -> If `localhost` doesn't work on your computer, use `127.0.0.1`, which it's the same thing. +- [Notes about security](Security) - some things to think about to stay safe(r) + - [Using HAProxy](HAProxy-Config) - putting a proxy in front of the game server for security + - [Using Apache as a webserver](Apache-Config) - use Apache instead of Evennia's webserver (limited support) +- [Taking your server online](Online-Setup) - decide on where to host and configure your game for production +- [Client support grid](Client-Support-Grid) - clients known to work (or not) with Evennia diff --git a/docs/source/Setup/Setup-Quickstart.md b/docs/source/Setup/Setup-Quickstart.md new file mode 100644 index 0000000000..8a21c48139 --- /dev/null +++ b/docs/source/Setup/Setup-Quickstart.md @@ -0,0 +1,91 @@ +# Setup quickstart + +The Evennia server is installed, run and maintained from the terminal (console/CMD on Windows). Starting the +server doesn't make anything visible online. Once you download everything you can in fact develop your game +in complete isolation if you want, without needing any access to the internet. + +## Installation + +Evennia requires Python3.7+. As with most Python packages, using a +[virtualenv](../Glossary#Virtualenv) is recommended in order to keep your +installation independent from the system libraries. It's _not_ recommended +to install Evennia as superuser. + + pip install evennia + +If things worked, the `evennia` command should now be available. Use `evennia -h` for +usage help (or read on). + +If you are having trouble, want to install in some other way (like with Docker) or want to help develop +Evennia itself, check out the [Extended Installation instructions](Extended-Installation). +It also has a [troubleshooting section](Extended-Installation#Troubleshooting) for different operating +systems. + + +## Initialize a new game + +Use `cd` to enter a folder where you want to do your game development. Here (and in +the rest of this documentation we call this folder `mygame`, but you should of course +name your game whatever you like): + + evennia --init mygame + +This will create a new folder `mygame` (or whatever you chose) in your current location. This +contains + + +## Start the new game + +`cd` into your game folder (`mygame` above). Next run + + evennia migrate + +This will create the default database (Sqlite3). The database file ends up as `mygame/server/evennia.db3`. If you +ever want to start from a fresh database, just delete this file and re-run `evennia migrate` again. + + evennia start + +Fill in your user-name and password. This will be the "god user" or "superuser" in-game. The email is optional. + +If all went well, the server is now up and running. Point a legacy MUD/telnet client to `localhost:4000` or +a web browser at [http://localhost:4001](http://localhost:4001) to play your new (if empty) game! + +> If `localhost` doesn't work on your computer, use `127.0.0.1`, which it's the same thing. + + +## See server logs + +This will echo the server logs to the terminal as they come in + + evennia --log + +or + + evennia -l + + +You can also attach `--log` to other `evennia` commands to start the log right away, such as + + + evennia start -l + + +## Restarting and stopping + + +This will restart the server without disconnecting any connected players: + + evennia restart + +Do a full stop and restart (will disconnect everyone): + + evennia reboot + +Stop the server (will need to use `start` to activate it again): + + evennia stop + + +## The Next step + +Why not head into the [Starting Tutorial] to learn how to start making your new game. diff --git a/docs/source/index.md b/docs/source/index.md index e935b8cd92..02d219143c 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -17,12 +17,13 @@ This is the manual of [Evennia](http://www.evennia.com), the open source Python `MU*` creation system. - [Evennia Introduction](Evennia-Introduction) +- [Install & Setup Quickstart](Setup/Setup-Quickstart) - [Begin the starting tutorial](Howto/Starting/Starting-Introduction) - [How to get help](How-To-Get-And-Give-Help) ## Main sections -- [Setting up and running](Setup/Setup-Overview) - How to get, start and maintain the server +- [Setting up and running](Setup/Setup-Overview) - More on how to get, start and maintain the server - [Tutorials and Howto's](Howto) - Explains how to reach particular goals - [Core components](Components) - The building blocks of Evennia - [Concepts](Concepts) - Larger-scale concepts and features diff --git a/docs/source/toc.md b/docs/source/toc.md index 35bae0684a..e696f10549 100644 --- a/docs/source/toc.md +++ b/docs/source/toc.md @@ -121,9 +121,9 @@ - [Setup/Choosing An SQL Server](Setup/Choosing-An-SQL-Server) - [Setup/Client Support Grid](Setup/Client-Support-Grid) - [Setup/Evennia Game Index](Setup/Evennia-Game-Index) -- [Setup/Getting Started](Setup/Getting-Started) +- [Setup/Extended Installation](Setup/Extended-Installation) - [Setup/Grapevine](Setup/Grapevine) -- [Setup/HAProxy Config (Optional)](Setup/HAProxy-Config-(Optional)) +- [Setup/HAProxy Config](Setup/HAProxy-Config) - [Setup/How to connect Evennia to Twitter](Setup/How-to-connect-Evennia-to-Twitter) - [Setup/IRC](Setup/IRC) - [Setup/Installing on Android](Setup/Installing-on-Android) @@ -131,7 +131,9 @@ - [Setup/RSS](Setup/RSS) - [Setup/Running Evennia in Docker](Setup/Running-Evennia-in-Docker) - [Setup/Security](Setup/Security) +- [Setup/Settings File](Setup/Settings-File) - [Setup/Setup Overview](Setup/Setup-Overview) +- [Setup/Setup Quickstart](Setup/Setup-Quickstart) - [Setup/Start Stop Reload](Setup/Start-Stop-Reload) - [index](index)