Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/silentmecha/no-one-survived

No One Survived server on linux inside of Docker
https://github.com/silentmecha/no-one-survived

docker docker-compose noonesurvived server

Last synced: 10 days ago
JSON representation

No One Survived server on linux inside of Docker

Awesome Lists containing this project

README

        

# silentmecha/no-one-survived

This repository contains the files needed for the image silentmecha/no-one-survived:latest

## Usage

This stack uses an image from [atmoz](https://github.com/atmoz). To see more on the image used visit their github [https://github.com/atmoz/sftp](https://github.com/atmoz/sftp).

For more info on environment variables and what they do see [Environment Variables](#environment-variables)

### Simplest Method

The simplest usage for this is using the `docker-compose` method.

```console
git clone https://github.com/silentmecha/no-one-survived.git no-one-survived-server
no-one-survived-server
cp .env.example .env
nano .env
docker-compose up -d
```

### Without building the image locally

```console
git clone https://github.com/silentmecha/no-one-survived.git no-one-survived-server
cd no-one-survived-server
cp .env.example .env
nano .env
docker-compose pull
docker-compose up -d
```

### Updating

Updating is still currently in development so once that is sorted this README will be updated. The idea is to allow an image to be updated without needing to either download the full image or rebuilding the image

### Environment Variables

| Variable Name | Default Value | Description |
| -------------------- | --------------- | -------------------------------------------------------------------------------------------------- |
| MAP | Map01 | Type of map to play on currently there is only two options `Map01` and `Map02` |
| SESSIONNAME | DockerTestServer | Name of your server as seen in server browser (accepts spaces) |
| SERVERPASSWORD | | Password to enter your server |
| SERVERADMINPASSWORD | ChangeMe | Admin access password (also know as RCON password) |
| MAXPLAYERS | 20 | Maximum number of players |
| PORT | 7777 | Port used to connect to the server |
| QUERYPORT | 27015 | Port used to query the server |
| SFT_USER | foo | Username for SFTP access to edit save data |
| SFT_PASS | pass | Password for SFTP access to edit save data |
| SFT_PORT | 2222 | Port for SFTP access (should not be 22 )

For more info on the usage of SFTP see [here](https://github.com/atmoz/sftp). If you do not want to use a plane text password see [encrypted-password](https://github.com/atmoz/sftp#encrypted-password)

### Ports
Currently the following ports are used.

| Port | Type | Default |
| ---------------- | ---- | ------- |
| PORT | UDP | 7777 |
| QUERYPORT | UDP | 27015 |
| SFT_PORT | TCP | 2222 |

All these ports need to be forwarded through your router except for `SFT_PORT` unless you wish to remotely edit the save data.

## License

[MIT license](LICENSE)