Commit 31c5f72c authored by Lars Kruse's avatar Lars Kruse
Browse files

docs: use local Debian packages for bare-metal deployment

The Debian packages benefit from security support and should be much
easier to install for most users.

Currently all requirements of Auro Engine are packaged in Debian.
Thus the virtualenv-related documentation snippets can be removed.
parent d041f86c
Pipeline #1108 passed with stage
in 2 minutes and 7 seconds
...@@ -23,7 +23,6 @@ Aura Engine runs on any modern Debian-based OS. It requires at least ...@@ -23,7 +23,6 @@ Aura Engine runs on any modern Debian-based OS. It requires at least
- [Python 3.8+](https://www.python.org/downloads/release/python-380/) - [Python 3.8+](https://www.python.org/downloads/release/python-380/)
- [`pip`](https://pip.pypa.io/en/stable/) - [`pip`](https://pip.pypa.io/en/stable/)
- [`git`](https://git-scm.com/) - [`git`](https://git-scm.com/)
- [`virtualenv`](https://pypi.org/project/virtualenv/)
- [PostgreSQL 13+](https://www.postgresql.org/) - [PostgreSQL 13+](https://www.postgresql.org/)
...@@ -44,24 +43,16 @@ If you are developing engine you also might want the projects `steering`, `dashb ...@@ -44,24 +43,16 @@ If you are developing engine you also might want the projects `steering`, `dashb
## Preparation ## Preparation
In case of an development environment, create a virtual environment for your Python dependencies: Install dependencies:
```shell
python3.8 -m venv python
```
No worries, the resulting `python` directory is excluded from the git respostory.
To activate that environment, run
```shell
source python/bin/activate
```
Then, install the required dependencies
```shell ```shell
pip install -r requirements.txt apt install \
python3-flask \
python3-flask-sqlalchemy \
python3-http-parser \
python3-psycopg2 \
python3-requests \
python3-sqlalchemy \
python3-validators
``` ```
Create your base configuration from the sample configuration Create your base configuration from the sample configuration
...@@ -78,8 +69,6 @@ cp config/sample.production.engine.ini config/engine.ini ...@@ -78,8 +69,6 @@ cp config/sample.production.engine.ini config/engine.ini
Engine requires a PorstgreSQL database to cache any programme info locally: Engine requires a PorstgreSQL database to cache any programme info locally:
```bash ```bash
# Additional Python packages for PostgreSQL
pip3 install -r contrib/postgresql-requirements.txt
# Create database and user (change password in script) # Create database and user (change password in script)
sudo -u postgres psql -f contrib/postgresql-create-database.sql sudo -u postgres psql -f contrib/postgresql-create-database.sql
``` ```
...@@ -104,12 +93,6 @@ Required modifications are: ...@@ -104,12 +93,6 @@ Required modifications are:
## Running Engine ## Running Engine
If you have defined a virtual env during the installation step you'll need to activate it first. You'll have to do so whenever you gonna start your development environment:
```shell
source python/bin/activate
```
There's a convencience script `run.sh` to get engine started There's a convencience script `run.sh` to get engine started
```shell ```shell
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment