From e7ce26a28b0b434f76d40ad04cd3b7f6a3e14732 Mon Sep 17 00:00:00 2001 From: Chris Cromer Date: Fri, 22 Jul 2022 23:20:43 -0400 Subject: [PATCH] add configuration and move license --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4d1c9b2..e4ef960 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,9 @@ This is the server which will host the Alai game binaries, backend API that rece - Christohper Cromer - Martín Araneda Acuña +## License +The server is licensed under the [3-Clause BSD License](LICENSE). + ## Backend API The backend is written in *go* and uses gorm to handle its database schema. @@ -15,6 +18,10 @@ The backend is written in *go* and uses gorm to handle its database schema. The directory game should contain the binaries for Alai which will be exposed through nginx for downloading. +## Configure + +Before the server can be built and run, a *.env* file should be created based on *.env.example*. If the server is going to be public facing, make sure to change all the secrets and passwords to make it more secure. + ## Build and run ``` @@ -25,7 +32,4 @@ docker-compose up -d --build ``` docker-compose down -``` - -## License -The server is licensed under the [3-Clause BSD License](LICENSE). \ No newline at end of file +``` \ No newline at end of file