This repository has been archived on 2021-12-24. You can view files and clone it, but cannot push or open issues/pull-requests.
self-hosting/README.md

56 lines
1.8 KiB
Markdown
Raw Normal View History

2021-01-04 22:53:34 +01:00
# self-hosting
2021-04-23 21:06:42 +02:00
2020-12-30 15:27:57 +01:00
# Contents
The repo contains setup guides for the following:
* Vanilla Minecraft
* Modded Minecraft using Forge
* Modded Minecraft using Fabric
* Vanilla Terraria
* Modded Terraria (coming soon)
2021-01-04 22:53:34 +01:00
* Firefly 3
* Nginx
* My own backup scripts
2020-12-30 15:27:57 +01:00
Each directory contains (or will contain) its own `README.md` to aid with the
installation of that specific setup.
# General info
2021-04-23 21:06:42 +02:00
This info applies to all configs.
## Docker
2021-04-23 21:06:42 +02:00
2020-12-30 15:27:57 +01:00
All the setups named above use Docker and docker-compose. If you're on a
Linux-based server, you can find both `docker` and `docker-compose` in your
package manager (do note that the Docker package might be called `docker.io`).
Otherwise, the install instructions can be found
[here](https://docs.docker.com/engine/install/).
2020-12-30 16:43:58 +01:00
## Configuration
2021-04-23 21:06:42 +02:00
2021-01-04 22:53:34 +01:00
Most configuration can be done using a `.env` file with a provided
`.env.example` file to start from. This means that you never have to edit the
compose files, unless you wish to deviate from the default format.
2020-12-30 16:43:58 +01:00
## Building the image
2021-04-23 21:06:42 +02:00
You can build the container image using the command `docker-compose build`.
This will build all services specified in the `docker-compose.yml` file. Any
build configuration/environment variables can be defined in a `.env` file. A
`.env.example` file is given for each configuration.
## Running the container
2021-04-23 21:06:42 +02:00
For running the server, we can use `docker-compose up -d`. This will start the
service in the background. You can then see any logs using
`docker-compose logs`. If you want the logs to update automatically, use
`docker-compose logs -f`.
2020-12-30 15:27:57 +01:00
# Why did I make this?
2021-04-23 21:06:42 +02:00
2020-12-30 15:27:57 +01:00
Well, I just wanted to put all my knowledge in one basket. this makes it easier
to manage and share with others. I spend a lot of time tweaking these configs
and figuring out how they work best (for me at least), and wanted to share this
with everyone else.