From 31bc958d8684381ed8bd95a98acbdc7260b478a7 Mon Sep 17 00:00:00 2001 From: Griatch Date: Sat, 30 Jan 2021 13:24:52 +0100 Subject: [PATCH] Update docs with new start envvars info --- docs/source/Setup/Extended-Installation.md | 17 ++++++++++++++++- docs/source/Setup/Start-Stop-Reload.md | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/source/Setup/Extended-Installation.md b/docs/source/Setup/Extended-Installation.md index a33aa446ce..dfbae66c79 100644 --- a/docs/source/Setup/Extended-Installation.md +++ b/docs/source/Setup/Extended-Installation.md @@ -430,6 +430,21 @@ Your game should now be running! Open a web browser at `http://localhost:4001` or point a telnet client to `localhost:4000` and log in with the user you created. Check out [where to go next](./Getting-Started#where-to-go-next). +## Non-interactive setup + +When you first run `evennia start` after having created the database, you will be asked +to interactively insert the superuser username, email and password. If you need to do +this in an automated faction (such as in an automated build flow), you can supply those +values as environment variables, `EVENNIA_SUPERUSER_USERNAME`, `EVENNIA_SUPERUSER_EMAIL` and +`EVENNIA_SUPERUSER_PASSWORD`. The email can be left out and will then be set to be the +empty string. + +Use this to start Evennia (the envvars will be ignored on subsequent starts): + +``` +EVENNIA_SUPERUSER_USERNAME=Foo EVENNIA_SUPERUSER_PASSWORD=MygreatPwd evennia start + +``` ## Where to Go Next @@ -533,4 +548,4 @@ path to the `twistd` executable. This file is auto-generated, so try to delete i `evennia start` to rebuild it and see if it works. If it still doesn't work you need to open it in a text editor like Notepad. It's just one line containing the path to the `twistd.exe` executable as determined by Evennia. If you installed Twisted in a non-standard location this might be wrong and -you should update the line to the real location. \ No newline at end of file +you should update the line to the real location. diff --git a/docs/source/Setup/Start-Stop-Reload.md b/docs/source/Setup/Start-Stop-Reload.md index 4bd2456bbe..a482b39ff6 100644 --- a/docs/source/Setup/Start-Stop-Reload.md +++ b/docs/source/Setup/Start-Stop-Reload.md @@ -193,4 +193,4 @@ Fix your bug then run evennia start Assuming the bug was fixed, this will start the Server manually (while not restarting the Portal). -In-game you should now get the message that the Server has successfully restarted. \ No newline at end of file +In-game you should now get the message that the Server has successfully restarted.