Dockerize infclass-stats (#31)

Author: ResamVi

.dockerignore

@@ -0,0 +1,5 @@
+web
+README.md
+LICENSE
+docker-compose.yml
+Dockerfile

.gitignore

@@ -3,7 +3,6 @@ memory.db
 node_modules
 /dist
 src/log.txt
-/config
 log.txt
 
 # local env files

Dockerfile

@@ -0,0 +1,13 @@
+FROM golang:1.15
+
+RUN mkdir /app
+ADD . /app/
+WORKDIR /app
+
+RUN go build
+
+RUN chmod +x start.sh
+
+EXPOSE 8001
+
+CMD ["./start.sh"]

README.md

@@ -43,93 +43,41 @@ Visit [https://stats.resamvi.io](https://stats.resamvi.io) to see yourself.
 
 infclass-stats runs on Port `8000` so make sure it is free.
 
-Fill the <..> with your information:
+Fill the environment variables with your information:
 
-`autoexec.cfg` of the teeworlds server
+`autoexec.cfg`
 ```
-ec_bindaddr <ip>
-ec_port <port>
-ec_password <password>
+ec_bindaddr <myip>
+ec_port <myport>
+ec_password <mypassword>
 ec_output_level 2
 ```
 
-Set up your `config/config.go` of infclass-stats
+`docker-compose.yml` should match the above
 ```
-SERVER_IP = "<ip>"
-
-ECON_PORT = "<port>"
-
-ECON_PASSWORD = "<password>"
-
-...
-
-MYSQL_USER = "<mysql user>"
-
-MYSQL_PASSWORD = "<mysql password>"
+- SERVER_IP=<myip>
+- ECON_PORT=<myport>
+- ECON_PASSWORD=<mypassword>
 ```
 
-Setup a database named "infclass"
-
-Replace the IP in `web/src/App.vue`
-```
-const ws = new WebSocket('ws://<ip>:8000/');
+`web/Dockerfile`
 ```
-
-Then run
-
+ENV VUE_APP_API_URL="wss://inf.resamvi.io:8001"
 ```
-go run main.go
-```
-
-or
-
-```
-./start.sh
-```
-which does the above repeatedly (helps recovering, when server crashes)
-
-
-# Config
-
-# SSL
 
-This implementation uses SSL. If you want to skip (easier testing) this step then:
+I'm using [Plausible](https://plausible.io/).  
+If you host this yourself you may want to stop the app from sending user stats:
 
-Change `wss` to `ws` in `App.vue`
+`web/public/index.html`
+```diff
+    ...
+    <title>InfClass Statistics</title>
 
-```
-const ws = new WebSocket('ws://localhost:8000/subscribe');
+-   <script async defer data-domain="stats.resamvi.io" src="https://pls.resamvi.io/js/pls.js"></script>
+</head>
 ```
 
-If you plan to use SSL create a symlink to the project root
-
-```
-ln -s /etc/letsencrypt/live/<url>/fullchain.pem ~/infclass-stats/fullchain.pem
-ln -s /etc/letsencrypt/live/<url>/privkey.pem ~/infclass-stats/privkey.pem
-```
 
 # How to make sure your Infclass mod is compatible with infclass-stats
 
-TODO
-
-Copy in what message logs are required 'Protocol'
-
-# TODO
-
-- Remove logs and fmts where possible
-
-# Website
-
-1. Install dependencies
-
-```
-yarn install
-```
-
-2. Build artifacts`
-
-```
-yarn run build
-```
-
-3. Move `dist` to `/var/www/` or appropriate place
+TODO: Copy in what message logs are required 'Protocol'

config/config.go

@@ -0,0 +1,25 @@
+package config
+
+import "os"
+
+var (
+	// SERVER_IP is the IP to the machine running the teeworlds server
+	SERVER_IP = os.Getenv("SERVER_IP")
+	// ECON_PORT is the port to econ (set via ec_port in autoexec.cfg)
+	ECON_PORT = os.Getenv("ECON_PORT")
+	// ECON_PASSWORD is the password to authenticate (set via ec_password)
+	ECON_PASSWORD = os.Getenv("ECON_PASSWORD")
+
+	// DEBUG_MODE gives additional logs
+	DEBUG_MODE = true
+
+	// SERVE_API will initialize a web server on port 8000 that serves a websocket connection
+	SERVE_API = true
+
+	// MYSQL_USER username to mysql database
+	MYSQL_USER = os.Getenv("MYSQL_USER")
+	// MYSQL_PASSWORD password to mysql database
+	MYSQL_PASSWORD = os.Getenv("MYSQL_PASSWORD")
+	// MYSQL_DB is the name to the database
+	MYSQL_DB = os.Getenv("MYSQL_DB")
+)

docker-compose.yml

@@ -0,0 +1,36 @@
+version: '3'
+services:
+    infclass:
+        build: ./
+        restart: always
+        ports:
+            - "8001:8001"
+        environment:
+            - SERVER_IP=192.169.0.1337 # adjust to your settings
+            - ECON_PORT=8001 # adjust to your settings
+            - ECON_PASSWORD=econpw # adjust to your settings
+            - MYSQL_USER=infclassuser
+            - MYSQL_PASSWORD=infclasspw
+            - MYSQL_DB=infclassdb
+
+    infclass_db:
+        image: mariadb:10.3.29
+        restart: always
+        volumes:
+          - infclass_data:/var/lib/mysql
+        ports:
+            - "3306:3306"
+        environment:
+            - MARIADB_ROOT_PASSWORD=rootpw
+            - MARIADB_USER=infclassuser
+            - MARIADB_PASSWORD=infclasspw
+            - MARIADB_DATABASE=infclassdb
+    
+    infclass_web:
+        build: ./web
+        ports:
+            - "80:80"
+
+
+volumes:
+    infclass_data:

infrastructure/gorm.go

@@ -270,7 +270,7 @@ func (repo GormRepo) Reset() {
 // Creates the tables if they do not exist yet and seeds the database
 // with an initial set of class objects to track overall class-specific performance.
 func NewGormDB() GormRepo {
-	args := config.MYSQL_USER + ":" + config.MYSQL_PASSWORD + "@/" + config.MYSQL_DB
+	args := config.MYSQL_USER + ":" + config.MYSQL_PASSWORD + "@tcp(infclass_db:3306)/" + config.MYSQL_DB
 	db, err := gorm.Open("mysql", args)
 	if err != nil {
 		log.Panicf("Could not connect to database: %s\n%s\n", args, err.Error())

infrastructure/webserver.go

@@ -19,7 +19,6 @@ package infrastructure
 
 import (
 	"encoding/json"
-	"infclass-stats/config"
 	"infclass-stats/operations"
 	"net/http"
 	"time"
@@ -41,22 +40,15 @@ type WebserviceHandler struct {
 // TODO: Dont make Serve create the handler himself
 func Serve(controller operations.Controller) {
 	webserviceHandler := WebserviceHandler{Controller: controller}
-	
+
 	http.HandleFunc("/", func(res http.ResponseWriter, req *http.Request) {
 		webserviceHandler.getUpdates(res, req)
 	})
 
 	go func() {
-		if config.USE_SSL {
-			err := http.ListenAndServeTLS(":8000", config.CERT_FILE, config.KEY_FILE, nil)
-			if err != nil {
-				log.Panic(err)
-			}
-		} else {
-			err := http.ListenAndServe(":8000", nil)
-			if err != nil {
-				log.Panic(err)
-			}
+		err := http.ListenAndServe(":8001", nil)
+		if err != nil {
+			log.Panic(err)
 		}
 	}()
 }

main.go

@@ -57,7 +57,7 @@ func main() {
 	infrastructure.Listen(file, controller)
 
 	if config.SERVE_API {
-		log.Info("Starting HTTP server on localhost:8000")
+		log.Info("Starting HTTP server on localhost:8001")
 		infrastructure.Serve(controller)
 	}
 

operations/ticker.go

@@ -164,8 +164,6 @@ func (c Controller) Infect(name string, aliveTime int) {
 		return
 	}
 
-	fmt.Println(name)
-
 	status := c.StatusRepository.FindStatusByName(name)
 	c.AddTimeAlive(status.ClassPicked, aliveTime, c.StatusRepository.GetMap())
 	//c.AddPick(status.CurrentClass)

start.sh

@@ -1,2 +1,2 @@
 #!/bin/bash
-while true; do go run main.go && break; done
+while true; do ./infclass-stats && break; done

web/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:16.1.0 as build-stage
+WORKDIR /app
+COPY package*.json ./
+ENV VUE_APP_API_URL="wss://inf.resamvi.io"
+RUN npm install
+COPY . .
+RUN npm run build
+
+# production stage
+FROM nginx:stable-alpine as production-stage
+COPY --from=build-stage /app/dist /usr/share/nginx/html
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]