mirror of
https://codeberg.org/spire/dispenser.git
synced 2026-06-03 10:04:07 +02:00
readme changes
This commit is contained in:
parent
01e48520c6
commit
6556a93f0b
2 changed files with 28 additions and 2 deletions
28
README.md
28
README.md
|
|
@ -20,7 +20,33 @@ You'll need to manually destroy the existing server in that case.
|
||||||
|
|
||||||
You can overwrite this behavior by setting `manage_existing = true` in your `config.toml`,
|
You can overwrite this behavior by setting `manage_existing = true` in your `config.toml`,
|
||||||
|
|
||||||
|
## Manual usage
|
||||||
|
|
||||||
|
Instead of managing the servers on a schedule with a background server you can also manually manage the server.
|
||||||
|
|
||||||
|
### List running servers
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dispenser config.toml list
|
||||||
|
```
|
||||||
|
|
||||||
|
### Start a new server
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dispenser config.toml start
|
||||||
|
```
|
||||||
|
|
||||||
|
Note that this will not start an additional server is a server is already running
|
||||||
|
|
||||||
|
### Stop a running server
|
||||||
|
|
||||||
|
```shell
|
||||||
|
dispenser config.toml stop
|
||||||
|
```
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [x] don't blindly kill server if there are players connected
|
- [x] don't blindly kill server if there are players connected
|
||||||
- [ ] kill the server earlier if everyone disconnected
|
- [ ] kill the server earlier if everyone disconnected
|
||||||
|
- [x] digital ocean backend
|
||||||
|
- [ ] more backends?
|
||||||
|
|
@ -8,7 +8,7 @@ config_mode = "6v6" # 6v6 or 9v9, defaults to "6v6"
|
||||||
name = "Spire" # server name. optional, defaults to "Spire"
|
name = "Spire" # server name. optional, defaults to "Spire"
|
||||||
tv_name = "SpireTV" # stv name. optional, defaults to "SpireTV"
|
tv_name = "SpireTV" # stv name. optional, defaults to "SpireTV"
|
||||||
image = "spiretf/docker-spire-server" # docker image for the tf2 server. optional, defaults to "spiretf/docker-spire-server"
|
image = "spiretf/docker-spire-server" # docker image for the tf2 server. optional, defaults to "spiretf/docker-spire-server"
|
||||||
ssh_keys = ["ssh-rsa AAAA..."] # ssh key to add to the server. optional
|
ssh_keys = ["ssh-rsa AAAA..."] # ssh keys to add to the server. optional
|
||||||
manage_existing = false # whether to detect and manage server that are already running, optional, disabled by default
|
manage_existing = false # whether to detect and manage server that are already running, optional, disabled by default
|
||||||
|
|
||||||
# Specify either the vultr settings or the digitalocean settings to pick the cloud provider
|
# Specify either the vultr settings or the digitalocean settings to pick the cloud provider
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue