DEPLOY.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# Instructions for Deployment on an Apache server (version 2.4) on Ubuntu (22.04.1 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` by running `apt-get install libapache2-mod-wsgi-py3`. This is an Apache module for WSGI.
        It's 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.
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 `DB_FILE` 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 `DB_FILE` 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.