Github Workflow

Skript som setter opp en virtuell maskin og dytter nyeste oppdateringene til serveren. Deretter aktiverer workflowen et build.sh bash-skript (se nedenfor).

.github/workflows/build-website.yml

name: build site

on:
  push:
    paths:
      - 'Prototypes/web/**'
      - '.github/workflows/**'

jobs:
  deploy: 
    runs-on: ubuntu-latest

    steps:
      - name: get repo web
        uses: actions/checkout@v4
      
      - name: setup ssh
        run: |
          mkdir -p ~/.ssh
          echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
          chmod 600 ~/.ssh/id_rsa
          ssh-keyscan -H ${{ vars.SERVER_IP }} >> ~/.ssh/known_hosts
        env:
          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}

      - name: copy files
        env:
          MQTT_ADMIN_USERNAME: ${{ secrets.MQTT_ADMIN_USERNAME }}
          MQTT_ADMIN_PASSWORD: ${{ secrets.MQTT_ADMIN_PASSWORD }}
          FLASK_SECRET_KEY: ${{ secrets.FLASK_SECRET_KEY }}
        run: |
          rsync -avz --delete -e "ssh -i ~/.ssh/id_rsa" Prototypes/web/ gruppe1@${{ vars.SERVER_IP }}:/srv
          ssh -i ~/.ssh/id_rsa gruppe1@${{ vars.SERVER_IP }} 'cat <<EOF > /srv/.env
          MQTT_ADMIN_USERNAME=${{ secrets.MQTT_ADMIN_USERNAME }}
          MQTT_ADMIN_PASSWORD=${{ secrets.MQTT_ADMIN_PASSWORD }}
          FLASK_SECRET_KEY=${{ secrets.FLASK_SECRET_KEY }}
          EOF'
          
      - name: make executable
        run: ssh -i ~/.ssh/id_rsa gruppe1@${{ vars.SERVER_IP }} 'chmod +x /srv/build.sh'

      - name: run build script
        run: ssh -i ~/.ssh/id_rsa gruppe1@${{ vars.SERVER_IP }} 'bash /srv/build.sh'

Bash-script

Skript som restarter tjenester og sørger for at python er oppdatert og kjører i riktig miljø.

build.sh

#!/bin/bash

# move new files if modified
sudo rsync -av /srv/app/static/index.html /var/www/html/index.html
sudo rsync -av /srv/nginx/default /etc/nginx/sites-enabled/default
sudo rsync -av /srv/services/gunicorn.service /etc/systemd/system/gunicorn.service
sudo rsync -av /srv/services/pymqtt.service /etc/systemd/system/pymqtt.service
sudo rsync -av --delete /srv/mosquitto/ /etc/mosquitto/conf.d/

prj_path="/srv"
venv="${prj_path}/venv"
requirements="${prj_path}/requirements.txt"

if [ ! -d "$venv" ]; then
    echo "no venv found trying to setup venv"
    if [ ! -f "$requirements" ]; then
        echo "no requirements file exiting"
        exit 1
    else
        echo "found requirements.txt setting up venv"
        python3 -m venv $venv
        echo "installing requirements.txt"
        source $venv/bin/activate
        pip3 install -r $requirements
    fi
fi

echo "create db"
source $venv/bin/activate
python3 /srv/db/setup_database.py

sudo systemctl daemon-reload

sudo systemctl restart pymqtt
sudo systemctl restart mosquitto
sudo systemctl restart gunicorn
sudo systemctl restart nginx
echo "completed build"

Database

Enkelt python-script som setter opp test-data til nettsiden.

db/setup_database.py

from tinydb import TinyDB
import os

base_dir = os.path.dirname(os.path.abspath(__file__))
nfctag_db_path = os.path.join(base_dir, "nfctags.json")


if not os.path.exists(nfctag_db_path):
    os.makedirs(os.path.dirname(nfctag_db_path), exist_ok=True)
    db = TinyDB(nfctag_db_path)
    db.insert({"nfctagID": "nfctag1", "poiID": 303578, "audio_filename": "someplace.opus"})
    db.insert({"nfctagID": "33F55B03", "poiID": 36148, "audio_filename": "bober.opus"})
    db.insert({"nfctagID": "83C7E411", "poiID": 1000459343, "audio_filename": "tapirbygget.opus"})
    db.insert({"nfctagID": "93C0930D", "poiID": 1000319015, "audio_filename": "sentralbygget.opus"})
else:
    print("nfctagdb already exists")

#https://use.mazemap.com/#v=1&campusid=1&zlevel=2&center=10.405620,63.418025&zoom=19&sharepoitype=poi&sharepoi=1000459343 tapirbygget
#https://use.mazemap.com/#v=1&campusid=1&zlevel=3&center=10.405620,63.418025&zoom=19&sharepoitype=poi&sharepoi=36148 bober
#https://use.mazemap.com/#v=1&campusid=1&zlevel=1&center=10.403742,63.417721&zoom=19.6&sharepoitype=poi&sharepoi=1000319015 sentralbygget

uuid_db_path = os.path.join(base_dir, "uuids.json")

if not os.path.exists(uuid_db_path):
    print("creating uuid-db")
    os.makedirs(os.path.dirname(uuid_db_path), exist_ok=True)
    db = TinyDB(uuid_db_path)
    r, g, b = 128, 184, 180
    db.insert({"uuid": "123e4567-e89b-12d3-a456-426614174000", "color": f"#{r:02x}{g:02x}{b:02x}"})
    r, g, b = 134, 181, 124
    db.insert({"uuid": "123e4567-e89b-12d3-a456-426614174002", "color": f"#{r:02x}{g:02x}{b:02x}"})
else:
    print("uuiddatabase already exists")

Oppstart

Gunicorn kaller denne filen for å starte web-appen.

production.py

from app import create_app
from werkzeug.middleware.proxy_fix import ProxyFix

app = create_app()
app.wsgi_app = ProxyFix(app.wsgi_app, x_for=1, x_proto=1, x_host=1, x_prefix=1)