games/factorio-server-manager
games/factorio-server-manager
1
0
Fork 0
mirror of https://github.com/OpenFactorioServerManager/factorio-server-manager.git synced 2025-01-26 05:27:21 +02:00
Code Issues Releases Activity

Update docker readme

Browse Source
This commit is contained in:
Mitch Roote 2018-01-21 14:17:33 -05:00
parent 44b330d44a
commit 1a337cf138
1 changed files with 43 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
docker/README.md
View File

@ -1,9 +1,9 @@
# Factorio Server Manager Docker Image
### with SSL reverse-proxy pre-configured
# Factorio Server Manager Docker Image
## How to use?
## Getting started?
Pull the Docker container from Docker Hub using the pull command
```
docker pull majormjr/factorio-server-manager
```
@ -11,43 +11,63 @@ docker pull majormjr/factorio-server-manager
Now you can start the container by running:
```
docker run --name factorio-manager -d -p 80:80 -p 443:443 -p 34197:34197/udp majormjr/factorio-server-manager
docker run --name factorio-manager -d \
-p 80:80 \
-p 443:443 \
-p 34197:34197/udp \
majormjr/factorio-server-manager
```
If you want persistent data in your container also mount the data volumes when starting:
```
docker run --name factorio-manager -d -v [yourpath]:/opt/factorio/saves [yourpath]:/opt/factorio/mods [yourpath]:/opt/factorio/config -p 80:80 -p 443:443 -p 34197:34197/udp majormjr/factorio-server-manager
docker run --name factorio-manager -d \
-v [yourpath]:/opt/factorio/saves \
-v [yourpath]:/opt/factorio/mods \
-v [yourpath]:/opt/factorio/config \
-v [yourpath]:/security \
-p 80:80 \
-p 443:443 \
-p 34197:34197/udp \
majormjr/factorio-server-manager
```
## Security
This container will auto-generate self-signed ssl certificates on your machine.
## Accessing the application
It's advisable that you CHANGE the private key and certificate to one you generated yourself. Do not trust me! Trust yourselves!
Also if you get an actual SSL certificate for your key it will hide the annoying "the certificate is not trusted blablabla" message.
### But how do I change it?
Nothing easier than that:
When first running the container you need to mount the security volume to your host machine by running `docker run --name factorio-manager -d -v [yourpath]:/security -p 80:80 -p 443:443 -p 34197:34197/udp factorio-server-manager`
The directory will contain a "server.key" file and a "server.crt" file.
If you replace these with a trusted SSL certificate and key, you should check that "server.crt" contains the whole certificate chain from the root of your CA.
Go to the port specified in your `docker run` command in your web browser. If running on localhost host access the application at https://localhost
## Updating Credentials, adding and deleting users.
An admin user is created initially using the credentials defined in the factorio-server-manager config file.
The default admin credentials are `user:admin password:factorio`.
An admin user is created initially using the credentials defined in the factorio-server-manager config file.
Users can be added and deleted on the settings page.
## Updating Factorio
For now you can't update/downgrade the Factorio version from the UI.
You can however do this using docker images while sustaining your security settings and map/modfiles.
For now you can't update/downgrade the Factorio version from the UI.
You can however do this using docker images while sustaining your security settings and map/modfiles.
This guide assumes that you mounted the volumes /security, /opt/factorio/saves, /opt/factorio/config and /opt/factorio/mods to your file system. Before doing anything we need to stop the old container using `docker stop factorio-manager`. To update Factorio you should then open the Dockerfile and change the Factorio version to the one desired. After that you need to rebuild the image using `docker build -t factorio-server-manager .`. Once completed you can simply rerun the command that you used to run the image in the first place. It's recommended to change the name to something including the version to keep track of the containers.
Pull the latest container with `docker pull majormjr/factorio-server-manager` and start with the `docker run` command.
## Security
A self generated SSL/TLS certificate is created when the container is first created and the webserver is accessible via HTTPS.
Authentication is supported in the application but it is recommended to ensure access to the Factorio manager UI is accessible via VPN or internal network.
### Changing SSL/TLS certificate
If you have your own SSL/TLS certificate then you can supply it to the Factorio Server Manager container.
When first running the container you need to mount the security volume to your host machine by adding the security volume parameter `-v [yourpath]:/security`
The directory will contain a "server.key" file and a "server.crt" file.
If you replace these with a trusted SSL certificate and key, you should ensure that "server.crt" contains the whole certificate chain from the root of your CA.
## For everyone who actually read this thing to the end
And now go and build some nice factories!