gnuviech/gva
1
0
Fork 0
Code Issues 6 Pull requests Releases Wiki Activity

Update install documentation

Browse source
This commit is contained in:
Jan Dittberner 2020-04-10 14:36:22 +02:00
parent 73b70bf35f
commit 9e3b7ba133
1 changed files with 13 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
docs/install.rst
View file

@ -1,59 +1,22 @@
Installation .. index:: installation
============
You have several options in setting up your working environment. We recommend =======
using virtualenv to separate the dependencies of your project from your Install
system's python environment. If on Linux or Mac OS X, you can also use =======
virtualenvwrapper to help manage multiple virtualenvs across different
projects.
Virtualenv Only Working Environment
--------------- ===================
First, make sure you are using virtualenv (http://www.virtualenv.org). Once To get a running work environment use `pipenv`_.
that's installed, create your virtualenv::
$ virtualenv --distribute gnuviechadmin .. _pipenv: https://pipenv.kennethreitz.org/en/latest/
You will also need to ensure that the virtualenv has the project directory To get started install `pip` and `pipenv` and use `pipenv install --dev`:
added to the path. Adding the project directory will allow `django-admin.py` to
be able to change settings using the `--settings` flag.
Virtualenv with virtualenvwrapper .. code-block:: sh
------------------------------------
In Linux and Mac OSX, you can install virtualenvwrapper $ apt install python3-pip
(http://virtualenvwrapper.readthedocs.org/en/latest/), which will take care of $ python3 -m pip install --user -U pipenv
managing your virtual environments and adding the project path to the $ pipenv install --dev
`site-directory` for you::
$ mkdir gnuviechadmin
$ mkvirtualenv -a gnuviechadmin gnuviechadmin-dev
$ cd gnuviechadmin && add2virtualenv `pwd` $ cd gnuviechadmin && add2virtualenv `pwd`
Installation of Dependencies
=============================
Depending on where you are installing dependencies:
In development::
$ pip install -r requirements/local.txt
For production::
$ pip install -r requirements.txt
PowerDNS setup
==============
The models in :py:mod:`domains.models` are meant to be used together with a
PowerDNS setup with the generic PostgreSQL backend
(https://doc.powerdns.com/md/authoritative/backend-generic-mypgsql/). The
database schema differs a bit from the original schema to fit the Django model
conventions. To make PowerDNS work you have to redefine the SQL statements by
copying the following content to
:file:`/etc/powerdns/pdns.d/pdns.local.gva_queries.conf`.
.. literalinclude:: pdns.local.gva_queries.conf
:language: properties