Description

This repository contains a webapp used to upload exams, notes and other materials to the DAT (Delegació d'Alumnes de Telecomunicacions) website. It is developed using Python3 and the Django framework.

Source code

All the files in this repository are licensed under the GNU Affero General Public License 3, or any later version.

Installation

Development

This installation notes are for a development environment. For a production environment please see the Production section below.

1. Create the file UploaderExamensApunts/settings_secret.py:

# Create a settings_secret.py for DB credentials following this format:
SECRET_KEY_SAVED='SECRET_KEY'
DATABASE_MYSQL="DBName"
USER_NAME="user"
PASSWORD="password"
HOST='127.0.0.1'
TOKEN="TOKEN_TO_UPDATE_SUBJECTS"

2. Create migrations directories:

mkdir uploader/migrations
touch uploader/migrations/__init__.py

3. Install required software:

sudo apt install docker.io

4. Build the Docker image:

docker build --tag=dat-uploader .

5. Create the container:

docker run -it -p 8000:8000 -v $(pwd):/app dat-uploader

To stop and start the container:

docker stop <container_id>
docker start -a <container_id>

Production

Apache2

1. Install required software:

sudo apt install python3 python3-venv python3-pip git mysql-server mysql-client python3-mysqldb python3-dev libz-dev libjpeg-dev libfreetype6-dev libapache2-mod-wsgi-py3

2. Create a virtual environment:

python3 -m venv UploaderExamensApunts
cd UploaderExamensApunts
source bin/activate

3. Install Django:

pip3 install Django==2.2.9 django-simple-captcha mysqlclient Unidecode

4. Configure the database:

sudo mysql
mysql> CREATE DATABASE dat_uploader;
mysql> CREATE USER 'dat'@'localhost' IDENTIFIED BY 'password';
mysql> GRANT ALL PRIVILEGES ON dat_uploader.* TO 'dat'@'localhost';

During this step you should follow the instructions in UploaderExamensApunts/settings_secret.readme.

5. Configure the app:

git clone https://github.com/dat-upc/UploaderExamensApunts.git
cd UploaderExamensApunts
mkdir uploader/migrations
touch uploader/migrations/__init__.py
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py collectstatic

6. Set up a VirtualHost:

<IfModule mod_ssl.c>
<VirtualHost *:443>
        ServerAdmin [email protected]
        ServerName uploads.dat.upc.edu
        ServerAlias uploads.dat.upc.edu
        ErrorLog ${APACHE_LOG_DIR}/error.log
        CustomLog ${APACHE_LOG_DIR}/access.log combined

        Alias /static/ /path/to/static/
        Alias /media/ /path/to/media/
        <Directory /path/to/static/>
                Require all granted
        </Directory>
        <Directory /path/to/media/>
                Require all granted
        </Directory>

        WSGIDaemonProcess uploads.dat.upc.edu python-home=/path/to/venv python-path=/path/to/UploaderExamensApunts
        WSGIProcessGroup uploads.dat.upc.edu
        WSGIScriptAlias / /path/to/UploaderExamensApunts/UploaderExamensApunts/wsgi.py
		WSGIPassAuthorization On
        <Directory /path/to/UploaderExamensApunts/UploaderExamensApunts>
                Require all granted
        </Directory>

        SSLCertificateFile /etc/letsencrypt/live/uploads.dat.upc.edu/fullchain.pem
        SSLCertificateKeyFile /etc/letsencrypt/live/uploads.dat.upc.edu/privkey.pem
        Include /etc/letsencrypt/options-ssl-apache.conf
</VirtualHost>
</IfModule>