2020-12-31 11:46:00 +01:00
|
|
|
<!---
|
|
|
|
|
|
|
|
|
|
Copyright (C) 2020 Jef Roosens
|
|
|
|
|
|
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
|
2020-12-30 17:10:37 +01:00
|
|
|
# Build arguments
|
|
|
|
|
The only required build argument is `RELEASE_TAG`. This is the GitHub tag of
|
|
|
|
|
the release you wish to use. The releases can be found
|
|
|
|
|
[here](https://github.com/Pryaxis/TShock/releases). The release tag is the
|
|
|
|
|
identifier on the left. It should look something like `v4.4.0-pre15`. You can
|
|
|
|
|
then specify the variable in the `.env` file: e.g. `RELEASE_TAG=v4.4.0-pre15`
|
|
|
|
|
|
|
|
|
|
# Environment variables
|
|
|
|
|
The only provided environment variable is `AUTOCREATE`. This should be either
|
|
|
|
|
`1`, `2` or `3`. It specifies how big the generated world should, e.g. small,
|
|
|
|
|
medium or large. If a world file already exists, the existing file is used
|
|
|
|
|
instead of generating a new one.
|
|
|
|
|
|
|
|
|
|
# Mount points
|
|
|
|
|
There a three useful mount points defined:
|
|
|
|
|
|
|
|
|
|
* `/terraria/config`: this is where the server config files are located
|
|
|
|
|
* `/terraria/logs`: the server log files are dumped here
|
|
|
|
|
* `/terraria/worlds`: this is where the world files are stored
|
|
|
|
|
|
|
|
|
|
You can mount these directories somewhere in the host file system by specifying
|
|
|
|
|
the mount paths in the `.env` file. These can be both absolute or relative
|
|
|
|
|
paths.
|
|
|
|
|
|
|
|
|
|
# Other config variables
|
|
|
|
|
You can specify the port using the `PORT` variable. This configures which port
|
|
|
|
|
on the host system should be exposed for the Terraria server. This is also the
|
|
|
|
|
port you need to enter into the Terraria client in order to connect to the
|
|
|
|
|
server. The default port for Terraria servers is `7777`.
|
