Skip to content

Commit

Permalink
switch to python 3.8 and fix a broken link
Browse files Browse the repository at this point in the history
  • Loading branch information
muckelba committed Mar 22, 2022
1 parent 184c986 commit 2bebb85
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions installation/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ MAD requires the following things to be installed available on your server:
- A server/computer running Linux. RaspberryPis do work, but aren't recommended
- A 64-bit CPU for MAD is also highly recommended since some optional parts of MAD do require to run on 64-bit. It does have a fallback for 32-bit CPUs though
- MariaDB server
- Python 3.6 (or higher) and Python's package manager command line tool :code:`pip`. Current tested and working versions are 3.6, 3.7 and 3.8.
- Python 3.8 or 3.8 and Python's package manager command line tool :code:`pip`. 3.9 is currently not supported!
- Use a :code:`virtualenv` to install dependencies. Have a look at `this <https://docs.python.org/3/tutorial/venv.html>`_ and `this <https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/>`_ if you're new to :code:`virtualenv`

.. _sec_manual_system_prep:
Expand All @@ -24,7 +24,7 @@ System preparation

.. note::

This whole article assumes a fresh installed `Ubuntu 18.04 Server <https://www.ubuntu.com/download/server>`_. If you're running a more recent version of Ubuntu or another Linux distribution - that's totally fine, but keep in mind there may be some difference in your setup.
This whole article assumes a fresh installed `Ubuntu 20.04 Server <https://www.ubuntu.com/download/server>`_. If you're running a more recent version of Ubuntu or another Linux distribution - that's totally fine, but keep in mind there may be some difference in your setup.

.. _sec_manual_database:

Expand Down Expand Up @@ -75,16 +75,16 @@ MAD will install the latest database schema automatically on initial boot and no
Python
--------

Since Ubuntu 18.04 does comes with a pre-installed python3.6 version but without a pip3 installation, run this command to install it:
Since Ubuntu 20.04 does comes with a pre-installed python3.8 version but without a pip3 installation, run this command to install it:

.. code-block:: bash
apt install python3-pip python3-wheel
Make sure you have the right version installed, since even if python3.6 is installed, the `python3` command could still point to `python3.5` or below!
Make sure you have the right version installed, since even if python3.8 is installed, the `python3` command could still point to `python3.5` or below!
Check if `pip` and `python` is installed correctly by running:

- :code:`python3 --version` - should return 3.6.x
- :code:`python3 --version` - should return 3.8.x
- :code:`pip3 --version` - If it returns a version that is related to your python version, it is working.

.. _sec_manual_py_venv:
Expand Down Expand Up @@ -131,7 +131,7 @@ MAD will also check the screen on your phone every now and then to check for err
sudo apt-get install tesseract-ocr python3-opencv
Another but optional dependency you may want to install is `ortools <https://developers.google.com/optimization>`_. MAD utilizes ortools to generate more optimized routes for your areas and it is as quick as MAD's built-in routing algorithm if not even faster. The downside of this as states in `the requirements <../requirements>`_ is, that you need a 64-bit server.
Another but optional dependency you may want to install is `ortools <https://developers.google.com/optimization>`_. MAD utilizes ortools to generate more optimized routes for your areas and it is as quick as MAD's built-in routing algorithm if not even faster. The downside of this as states in :ref:`the requirements<Requirements>` is, that you need a 64-bit server.

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion installation/security/general_security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Here is some security advice that is not only related to MAD but to servers and
- Don't run MAD inside a webhosted directory like :code:`/var/www/html`.
- MAD does not need root privileges to run. Start it as a normal user. The only programs that need root are your webserver and your database.
- Don't use the same or similar passwords. A `password manager <https://keepass.info/>`_ can be useful for that.
- Use SSL whenever it's possible. Why? Read `this <https://howhttps.works/why-do-we-need-https/>`_
- Use SSL whenever it's possible. Why? Read `this <https://howhttps.works/why-do-we-need-https/>`_.

Firewall
^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ else (
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:auto
sphinx-autobuild . _build -H 0.0.0.0
sphinx-autobuild . _build --host 0.0.0.0
goto end

:end
Expand Down

0 comments on commit 2bebb85

Please sign in to comment.