notes_production.md

Notes - Production

• Setup
  • Requirements
  • Installation
  • Configuration
  • Run
  • Update
  • Deinstall
  • Backup & Restore
• Handbook
  • Verwaltung
    • Studenten

Setup

Requirements

• Docker, Git

Installation

1. Get the project:

   git clone https://github.com/tigion/htwd-project-se-team-management.git

Configuration

1. Go to the project folder:

   cd htwd-project-se-team-management

2. Copy or rename the .env.template file to .env:

   cp .env.example .env

3. Edit the .env file:

   vim .env

   [!WARNING] The default configuration is for local testing only. Values must be adjusted for productive use!

   • 🚧 ... A more detailed description of the settings follows later in a separate document

Run

1. Go to the project folder:

   cd htwd-project-se-team-management

2. Start with:

   # Linux
   sudo docker compose up -d
   # macOS
   docker compose up -d

3. Stop with:

   # Linux
   sudo docker compose down
   # macOS
   docker compose down

Update

• A simple variant:

  # Stop the Docker containers
  docker compose down
  # Update the project source
  git pull
  # Start the Docker containers
  sudo docker compose up -d

• A variant with reset Docker environment:

  # Stop the Docker containers and remove containers, images and networks
  # Can be run even if Docker has already been terminated
  docker compose down --rmi all --remove-orphans
  # Update the project source
  git pull
  # Start Docker with newly created containers, images and networks
  sudo docker compose up -d

  [!WARNING] With an additional --volume in docker compose down --rmi all --volumes --remove-orphans also volumes with important data will be removed!

Deinstall

1. Go to the project folder:

   cd htwd-project-se-team-management

2. Stop Docker with:

   # Linux
   sudo docker compose down
   # macOS
   docker compose down

3. [optional] Save relevant data (Backup & Restore)

4. Clean up Docker environment with:

   # Linux
   sudo docker compose down --rmi all --volumes --remove-orphans
   # macOS
   docker compose down --rmi all --volumes --remove-orphans

5. Remove project folder

   cd ..
   rm -rf htwd-project-se-team-management

Backup & Restore

Simply stop Docker and save or restore the configuration and data manually. Docker can then be restarted.

• Configuration: All settings are in the text file .env
• Data: All data are in the Sqlite database file src/backend/db.sqlite3

Handbook

Verwaltung

Studenten

Studenten aus Opal exportieren:

1. SE I -> Gruppenmanagement
2. Gruppe "Teilnehmer Projektarbeit"
3. Symbol Einträge auswählen: Vorname, Nachname, E-Mail-Adresse, Studiengruppe
4. Symbol Tabelle herunterladen -> table.xls
5. LibreOffice/Excell: als CSV-Datei speichern (Komma-Separator, Erste Zeile sind die Spaltennamen welche beim Import ignoriert werden)

Beim Import werden entweder nur neue Studenten importiert oder alle vorhandenen Studenten ersetzt.