diff --git a/INSTALL.txt b/INSTALL.txt index 06d1346..a339d4e 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -11,15 +11,23 @@ uwsgi-plugin-python3:2.0.20-4 apache2:2.4.52-1ubuntu4.2 python3-requests:2.25.1+dfsg-2 +However, most up to date packages should be fine. Installation ====== This software expects to be installed at /opt/kjv-api/ (for uwsgi use on a reverse proxy) +If you change this installation directoy, make sure kjv-api.sh has its path updated. This installation method is intended to play nice among other Virtual Hosts 0. Install dependancies listed at the head of this document. + - I used ubuntu repositories, but many can be installed via pip in a venv. it + would probably be a better way than with system repositories. uwsgi however is + a system package, I'm pretty sure. + - If you use pip/venv, you will need to modify the kjv-api.sh script to activate + the venv before executing it, I'm pretty sure. - You may substitute the webserver for one of your choice, as long as it's capable - of reverse proxy + of reverse proxy. Do not run it with the flask development server or serve directly + as a uswgi thing. 1. For security, create a new user with the name 'kjv' - sudo useradd -r -s /bin/false kjv @@ -33,7 +41,7 @@ This installation method is intended to play nice among other Virtual Hosts - term2. curl -XGET 127.0.0.1:1611/random 4. If you intend to set up the software as a persistant service, copy kjv-api.service from - the install folder to /etc/systemd/system/kjv-api.service + the install folder to /etc/systemd/system/kjv-api.service if you're using systemd. - sudo cp /opt/kjv-api/install/kjv-api.service /etc/systemd/system/ - sudo systemctl enable kjv-api.service - sudo systemctl start kjv-api.service