Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs with new start envvars info

Browse source
This commit is contained in:
Griatch 2021-01-30 13:24:52 +01:00
parent 71d00c3d5a
commit 31bc958d86
2 changed files with 17 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/source/Setup/Extended-Installation.md
View file

@ -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 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). 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 ## 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 `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 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 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. you should update the line to the real location.

2
docs/source/Setup/Start-Stop-Reload.md
View file

@ -193,4 +193,4 @@ Fix your bug then run
evennia start evennia start
Assuming the bug was fixed, this will start the Server manually (while not restarting the Portal). 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. In-game you should now get the message that the Server has successfully restarted.