INSTALL.md

   1 # Installation Instructions
   2 Note that these instructions are a work in progress and will change during the prototyping phase.
   3
   4 ## 1. Download the Project
   5
   6 Grab and extract a tarball or clone this repository into a convenient location,
   7 e.g. `/opt/yt` (the rest of these instructions will assume this path).
   8
   9         git clone ... /opt/yt
  10         cd /opt/yt
  11
  12 ## 2. Install Virtual Environment
  13
  14 For the most part, it doesn't matter where you set up the virtual environment.
  15 Here, it is created in `/opt/yt/venv`. You eill have to point the systemd unit
  16 files/init scripts and app/common/utils.py to it.
  17
  18         python3 -m venv venv
  19         . venv/bin/activate
  20         pip3 install -r config/requirements.txt
  21         deactivate
  22
  23 ## 3. Configuration
  24
  25 Configuration is read from the `YT_CONFIG` environment variable, falling back
  26 to `/etc/yt/config.ini`. You can keep the `config/` directory untouched to
  27 avoid merge conflicts, and copy the relevant files to `/etc/yt`.
  28
  29 Carefully read and fill out `config/config.ini`. If you want to run the app
  30 directly from gunicorn (as I do), the [Gunicorn configuration] file
  31 (`gunicorn-frontend-config.py`) will need TLS certificate paths. You can ignore
  32 `gunicorn-webhooks-config.py`, unless you want to run it standalone. Otherwise,
  33 configure them to use a high port and reverse-proxy them through your real web
  34 server.
  35 `gunicorn-frontend-config.py` uses eventlet workers, which require
  36 `gunicorn[eventlet]` to be installed. If you want a synchronous worker, use
  37 `gthread` instead.  If you are using the in-memory requests-cache, do not use
  38 more than 1 process, or the cache will be useless!
  39
  40 If you want to use the included systemd unit files, point `WorkingDirectory=`
  41 to the location of the repository, `Environment=PATH=` to the location of the
  42 virtualenv's `bin/` directory and `Environment=YT_CONFIG=` to your `config.ini`
  43 (if you aren't using `/etc/yt/config.ini`), as well as the gunicorn config
  44 path. Then copy them to `/etc/systemd/system/`.
  45
  46 **Do not start the frontend before the database and cronjobs are in place!**
  47
  48         cp -r config /etc/yt
  49         cp config/subscriptions-frontend.service /etc/systemd/system
  50
  51         vi /etc/yt/config.ini
  52         vi /etc/yt/gunicorn-frontend-config.py
  53         vi /etc/systemd/system/subscriptions-frontend.service
  54
  55         systemctl daemon-reload
  56         systemctl enable subscriptions-frontend.service
  57
  58 [Gunicorn configuration]: https://docs.gunicorn.org/en/stable/settings.html
  59
  60 ## 4. Create and Prepopulate SQLite Database
  61
  62 To create the database and tables, simply issue:
  63
  64         sqlite3 subscriptions.sqlite < config/setup.sql
  65
  66 Next, create a user for yourself:
  67
  68         USERN=your_name
  69         PASSWD=$(./config/generate-passwd.py) # will ask
  70         TOKEN=$(head -c16 </dev/urandom|base64|tr /+ _-|tr -d =)
  71         echo "INSERT INTO users(name, password, token) VALUES ('$USERN','$PASSWD','$TOKEN')" |
  72                 sqlite3 subscriptions.sqlite
  73
  74 The homepage will show the guest user's subscription feed. As you cannot log in
  75 as guest, you will have to populate this feed by INSERTing directly into the
  76 datbase. The README's *Advanced Topics* section has information on this. Or you
  77 can use the provided list:
  78
  79         sqlite3 subscriptions.sqlite < config/guest.sql
  80
  81 You can do the same for your own subscriptions, or use the *Subscription
  82 Manager* in the footer of the main page to subscribe to channels manually.
  83
  84 ## 5. Set up Cron Jobs
  85
  86 Cronjobs live in app/common/utils.py, which is both a python script and an
  87 executable shell script. When executed with `sh`, it will load the virtual
  88 environment and launch itself with it.
  89
  90 Before starting the frontend, run them once. `cipher` is required to play music
  91 videos; `pull` downloads a back catalog of subscriptions; `websub` will
  92 register for automatic push-updated on new videos. (Note: export `YT_CONFIG` if
  93 you don't use `/etc/yt/config`)
  94
  95         ./app/common/utils.py pull
  96         ./app/common/utils.py websub
  97         ./app/common/utils.py cipher
  98
  99 If all goes well, install them with `crontab -e`. Running `pull` and `cipher`
 100 once per day is plenty; `websub` should run at least twice daily (both `pull`
 101 and `websub` are idempotent; they won't do any additional work if ran multiple
 102 times).
 103
 104         YT_DIR=/opt/yt
 105         # YT_CONFIG=/opt/yt/config/config.ini # optional
 106         19 21 * * * $YT_DIR/app/common/utils.py pull
 107         03 */4 * * * $YT_DIR/app/common/utils.py websub
 108         52 02 * * * $YT_DIR/app/common/utils.py cipher
 109
 110 ## 6. Done
 111
 112 All set -- you can start the frontend now and relax.
 113
 114         systemctl start subscriptions-frontend.service