Skip to content

Commit

Permalink
Updates to developer_installation.rst (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
snesic committed Mar 4, 2022
1 parent 00bfc89 commit b017ad2
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions docs_manual/developer_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,14 @@ services not running in a Docker container.
Install Postgres
----------------

Follow the instructions for your operating system to install `Postgres <https://www.postgresql.org>`_.
For Ubuntu, this would be::
Follow the instructions for your operating system to install `Postgres <https://www.postgresql.org>`_.
Make sure that the version is 12 (11 and 13 would also work).
Ubuntu 20 already includes postgresql 12. In case of older Ubuntu versions, this would be::

sudo apt install postgresql-12



sudo apt install postgresql

-------------
Install Redis
Expand Down Expand Up @@ -68,18 +72,26 @@ Clone the VarFish Server repository and switch into the checkout.
Install Python Requirements
---------------------------

With the conda/Python environment activated, install all the requirements.
Some required packages have dependencies that are usually not preinstalled.
Therefore, run

.. code-block:: bash
$ sudo apt install libsasl2-dev python-dev libldap2-dev libssl-dev
Now, with the conda/Python environment activated, install all the requirements.

.. code-block:: bash
$ for i in requirements/*; do install -r $i; done
$ for i in requirements/*; do pip install -r $i; done
--------------
Setup Database
--------------

Use the tool provided in ``utility/`` to set up the database. The name for the
database should be ``varfish``.
database should be ``varfish`` (create new user: yes, name: varfish, password: varfish).

.. code-block:: bash
Expand All @@ -93,7 +105,7 @@ Use the tool provided in ``utility/`` to set up vue.js.

.. code-block:: bash
$ bash utility/setup_vue_dev.sh
$ sudo bash utility/install_vue_dev.sh
Open an additional terminal and switch into the vue directory. Then install
the VarFish vue app.
Expand Down Expand Up @@ -153,5 +165,5 @@ When done, open two terminals and start the VarFish server and the celery server

.. code-block:: bash
terminal1$ make server
terminal1$ make serve
terminal2$ make celery

0 comments on commit b017ad2

Please sign in to comment.