Add docker instructions

2023-02-19 17:40:07 -07:00
parent 8f4fc9103a
commit 1421c9d89e
1 changed files with 20 additions and 1 deletions
@@ -37,7 +37,26 @@ To run your own PvPGN server, first you must build it from source. ohea.xyz prov

 #### Using Docker

-**(TODO)**
+Clone the pvpgn Docker repo:
+
+```
+$ git clone https://git.ohea.xyz/containers/pvpgn
+$ cp docker-compose.override.yml.example docker-compose.override.yml 
+```
+
+Now you need to configure `docker-compose.override.yml`. The default configuration should be sufficent for most users. If you want to customize the PvPGN configuration files, the provided terms of service, or the provided new account creation info, you can uncomment the corresponding mappings.
+
+Run the docker container:
+
+```
+$ docker compose up -d
+```
+
+Your PvPGN server should now be running. It can be stopped by runnning:
+
+```
+$ docker compose down
+```

 #### Without Docker