# Instructions for Deployment on an Apache server (version 2.4) on Ubuntu (20.04 LTS)

1.  Set up the server environment
    -   If Python3 and jsonpickle aren't installed, this can be done using
        `apt-get update; apt-get install python3 python3-jsonpickle`.
    -   Install `mod_wsgi`, an Apache module for WSGI. This is for running `backend/tilo.py` to serve
        tree-of-life data, and is used instead of CGI to avoid starting a new process for each request.
        You can find instructions
        [here](https://modwsgi.readthedocs.io/en/master/user-guides/quick-installation-guide.html). The below
        is a rough summary of setup on Ubuntu.
        1.  Install some prerequisites
            1.  `apt-get update`
            1.  `sudo aptitude install apache2-dev python3-dev`
        1.  Download and build the module
            1.  Download the [source](https://github.com/GrahamDumpleton/mod_wsgi/releases) into `mod_wsgi-4.9.2.tar.gz`
            1.  `tar xvfz mod_wsgi-4.9.2.tar.gz`
            1.  `cd mod_wsgi-4.9.2`
            1.  `./configure --with-python=/usr/bin/python3`
            1.  `make`
        1.  Install and enable the module
            1.  `sudo make install`
            1.  Create /etc/apache2/mods-available/wsgi.load, and add the line
                `LoadModule wsgi_module /usr/lib/apache2/modules/mod_wsgi.so`
            1.  `sudo a2enmod wsgi`
            1.  `sudo systemctl restart apache2`
1.  Change some constants (automated by `prebuild.sh`)
    -   In `src/vite.config.js`: Set `base` to the URL path where Tilo will be accessible (eg: `'/tilo'`)
    -   In `src/lib.ts`:
        -   Set `SERVER_DATA_URL` to the URL where `backend/tilo.py` will be served
            (eg: `'https://terryt.dev/tilo/data'`)
        -   Set `SERVER_IMG_PATH` to the URL path where images will be served (eg: `'/img/tilo'`).
            If you place it within the `base` directory, you'll need to remember to move it when deploying
            a newer production build.
    -   In `backend/tilo.py`: Set `dbFile` to where the database will be placed (eg: `'/usr/local/www/db/tilo.db'`)
1.  Generate the client-side production build <br>
    Run `npm run build`. This generates a directory `dist/`.
1.  Copy files to the server (using ssh, sftp, or otherwise)
    1.  Copy `dist/` into Apache's document root, into the directory where Tilo will be served.
        The created directory should match up with the `base` value above (eg: `/var/www/terryt.dev/tilo/`).
    1.  Copy over `backend/tolData/data.db`. The result should be denoted by the `dbFile` value above.
        Remember to set ownership and permissions as needed.
    1.  Copy over the images in `backend/tolData/img/`. There are a lot of them, so compressing them
        before transfer is advisable (eg: `tar czf imgs.tar.gz backend/tolData/img/`). The location should
        match up with the `SERVER_IMG_PATH` value above (eg: `/var/www/terryt.dev/img/tilo/`).
    1.  Copy over `backend/tilo.py`. The location should be accessible by Apache (eg: `/usr/local/www/wsgi-scripts/`).
    1.  Edit the site's config file to serve tilo.py. The file path will likely be something like
        `/etc/apache2/sites-available/terryt.dev-le-ssl.conf`, and the edit should add lines like the following,
        likely within a `<VirtualHost>` section:
        
            WSGIScriptAlias /tilo/data /usr/local/www/wsgi-scripts/tilo.py
            <Directory /usr/local/www/wsgi-scripts>
                Require all granted
            </Directory>
        
        The first `WSGIScriptAlias` parameter should match the URL path in `SERVER_URL`, and the second should
        be the location of tilo.py. The `<Directory>` lines enable access for that location.