Documentation for Turris routers

This documentation is written in English. It will walk you through the first setup of your router and give you insights into the main features available in Turris OS.

We are using Markdown to document everything and mkdocs to handle the presentation.

Requirements:

First of all clone this repository via git.

git clone https://gitlab.nic.cz/turris/user-docs.git

To render this documentation, you need MkDocs.

Run the following pip3 command in the cloned repository to install it easily.

pip3 install --user -r requirements.txt

Error externally managed environment

If you run into this error due to your distribution adopting PEP 668 - Marking Python base environments as “externally managed”

error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try apt install
python3-xyz, where xyz is the package you are trying to
install.
...

Use venv

python3 -m venv .venv
source .venv/bin/activate

Then run the following command

python3 -m pip install -r…