Updated README

pull/3/head
Jef Roosens 2021-01-04 22:53:34 +01:00
parent 0b88c0c37f
commit b75b3cf274
1 changed files with 7 additions and 7 deletions

View File

@ -18,10 +18,7 @@ along with this program. If not, see <https://www.gnu.org/licenses/>.
--> -->
# karaoke-server # self-hosting
This repository contains the Docker scripts I use to manage our "gaming" VPS.
We mostly use it to play modded Minecraft together.
# Contents # Contents
The repo contains setup guides for the following: The repo contains setup guides for the following:
@ -30,6 +27,9 @@ The repo contains setup guides for the following:
* Modded Minecraft using Fabric * Modded Minecraft using Fabric
* Vanilla Terraria * Vanilla Terraria
* Modded Terraria (coming soon) * Modded Terraria (coming soon)
* Firefly 3
* Nginx
* My own backup scripts
Each directory contains (or will contain) its own `README.md` to aid with the Each directory contains (or will contain) its own `README.md` to aid with the
installation of that specific setup. installation of that specific setup.
@ -45,9 +45,9 @@ Otherwise, the install instructions can be found
[here](https://docs.docker.com/engine/install/). [here](https://docs.docker.com/engine/install/).
## Configuration ## Configuration
All configuration can be done using a `.env` file with a provided `.env.example` Most configuration can be done using a `.env` file with a provided
file to start from. This means that you never have to edit the compose files, `.env.example` file to start from. This means that you never have to edit the
unless you wish to deviate from the default format. compose files, unless you wish to deviate from the default format.
## Building the image ## Building the image
You can build the container image using the command `docker-compose build`. You can build the container image using the command `docker-compose build`.