Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updates to developer_installation.rst #340

Merged
merged 4 commits into from
Mar 4, 2022
Merged

Updates to developer_installation.rst #340

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e0f1c6
Update developer_installation.rst
snesic Feb 7, 2022
9e61992
add postgres version
snesic Feb 7, 2022
0971ff9
Update developer_installation.rst
snesic Feb 7, 2022
91a22c5
Update developer_installation.rst
snesic Feb 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions docs_manual/developer_installation.rst
View file
Open in desktop
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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rather add a note about this. Ubuntu 20 includes postgresql v12 as postgresql package.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note added




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