third-party-mirrors/EDDN
1
0
Fork 0
mirror of https://github.com/EDCD/EDDN.git synced 2025-06-05 18:03:04 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs/Running: ${HOME} not ~ / python venv un-versioned symbolic link

Browse Source 
* Let's stick with Bourne Shell, not BASH-isms.
* If we make everything use ~/eddn/python-venv symbolic link then
there's less to update in the future.
This commit is contained in:
Athanasius 2021-06-14 16:52:04 +01:00
parent b58acec1c9
commit c6db4b2733
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/Running-this-software.md
View File

@ -58,7 +58,7 @@ If you don't yet have nginx installed then start with:
#### LetsEncrypt TLS Certificates #### LetsEncrypt TLS Certificates
You will need a LetsEncrupt/ACME client in order to keep the TLS certificate You will need a LetsEncrypt/ACME client in order to keep the TLS certificate
renewed. renewed.
cd /etc/letsencrypt cd /etc/letsencrypt
@ -120,23 +120,29 @@ So as to not have any python package version requirements clash with
anything else it's best to use a Python virtual environment (venv). You anything else it's best to use a Python virtual environment (venv). You
will have installed the Debian package 'virtualenv' above for this purpose. will have installed the Debian package 'virtualenv' above for this purpose.
We'll put the venv in `~/eddn/python2.7-venv` with the following We'll put the venv in `${HOME}/eddn/python2.7-venv` with the following
command: command:
mkdir -p ${HOME}/eddn
cd ${HOME}/eddn
virtualenv -p /usr/bin/python2.7 ${HOME}/python2.7-venv virtualenv -p /usr/bin/python2.7 ${HOME}/python2.7-venv
And for future ease of changing python versions:
ln -s python2.7-venv python-venv
And now start using this venv: And now start using this venv:
. python2.7-venv/bin/activate . python-venv/bin/activate
### Clone a copy of the application project from gitub ### Clone a copy of the application project from gitub
mkdir -p ~/eddn/dev mkdir -p ${HOME}/eddn/dev
cd ~/eddn/dev cd ${HOME}/eddn/dev
git clone https://github.com/EDCD/EDDN.git git clone https://github.com/EDCD/EDDN.git
cd EDDN cd EDDN
We'll assume this `~/eddn/dev/EDDN` path elsewhere in this document. We'll assume this `${HOME}/eddn/dev/EDDN` path elsewhere in this document.
### Ensure necessary python modules are installed ### Ensure necessary python modules are installed
Installing extra necessary python modules is simple: Installing extra necessary python modules is simple:
@ -146,7 +152,7 @@ Installing extra necessary python modules is simple:
### Initialise Database Schema ### Initialise Database Schema
You will need to get the database schema in place: You will need to get the database schema in place:
mysql -p eddn < ~/eddn/dev/EDDN/schema.sql mysql -p eddn < ${HOME}/eddn/dev/EDDN/schema.sql
<the password you set in the "CREATE USER" statement above> <the password you set in the "CREATE USER" statement above>
### Monitor and Schema files ### Monitor and Schema files
@ -155,14 +161,14 @@ script, so you'll need to manually copy them into somewhere convenient,
e.g.: e.g.:
mkdir -p ${HOME}/.local/share/eddn mkdir -p ${HOME}/.local/share/eddn
cp -r ~/eddn/dev/EDDN/contrib/monitor ${HOME}/.local/share/eddn cp -r ${HOME}/eddn/dev/EDDN/contrib/monitor ${HOME}/.local/share/eddn
chmod -R og+rX ${HOME} ${HOME}/.local ${HOME}/.local/share ${HOME}/.local/share/eddn chmod -R og+rX ${HOME} ${HOME}/.local ${HOME}/.local/share ${HOME}/.local/share/eddn
You will need to ensure that the Monitor nginx setup can see the schema files You will need to ensure that the Monitor nginx setup can see the schema files
in order to serve them for use by the Gateway. So perform, e.g.: in order to serve them for use by the Gateway. So perform, e.g.:
mkdir -p ${HOME}/.local/share/eddn mkdir -p ${HOME}/.local/share/eddn
cp -r ~/eddn/dev/EDDN/schemas ${HOME}/.local/share/eddn cp -r ${HOME}/eddn/dev/EDDN/schemas ${HOME}/.local/share/eddn
chmod -R og+rX ${HOME}/.local/share/eddn/schemas chmod -R og+rX ${HOME}/.local/share/eddn/schemas
# Concepts # Concepts
@ -280,7 +286,7 @@ You have some choices for how to run the application components:
python setup.py install --user python setup.py install --user
to install under `~/.local/` instead. to install under `${HOME}/.local/` instead.
There is an example systemd setup in `contrib/systemd` that assumes There is an example systemd setup in `contrib/systemd` that assumes
this local installation. this local installation.
@ -290,12 +296,12 @@ You have some choices for how to run the application components:
`DAEMON` lines tweaking for running from another location. `DAEMON` lines tweaking for running from another location.
1. For quick testing purposes you can run them as follows, assuming you 1. For quick testing purposes you can run them as follows, assuming you
installed into `~/.local/`, and have your override settings in installed into `${HOME}/.local/`, and have your override settings in
`${HOME}/etc/eddn-settings-overrides.json`: `${HOME}/etc/eddn-settings-overrides.json`:
~/.local/bin/eddn-gateway --config ${HOME}/etc/eddn-settings-overrides.json >> ~/logs/eddn-gateway.log 2>&1 & ${HOME}/.local/bin/eddn-gateway --config ${HOME}/etc/eddn-settings-overrides.json >> ${HOME}/logs/eddn-gateway.log 2>&1 &
~/.local/bin/eddn-monitor --config ${HOME}/etc/eddn-settings-overrides.json >> ~/logs/eddn-monitor.log 2>&1 & ${HOME}/.local/bin/eddn-monitor --config ${HOME}/etc/eddn-settings-overrides.json >> ${HOME}/logs/eddn-monitor.log 2>&1 &
~/.local/bin/eddn-relay --config ${HOME}/etc/eddn-settings-overrides.json >> ~/logs/eddn-relay.log 2>&1 & ${HOME}/.local/bin/eddn-relay --config ${HOME}/etc/eddn-settings-overrides.json >> ${HOME}/logs/eddn-relay.log 2>&1 &
# Accessing the Monitor # Accessing the Monitor
There is an EDDN Status web page usually provided at, e.g. There is an EDDN Status web page usually provided at, e.g.