Starting with VyOS 1.2 (
crux) our documentation is being migrated from the old wiki
to ReadTheDocs. Documentation can be accessed via the following URL: https://docs.vyos.io
Our old WiKi can still be accessed from the Wayback Machine
Our version follows the very same branching scheme as the VyOS source modules
itself. We maintain one documentation branch per VyOS release. The default
branch that contains the most recent VyOS documentation is called
and matches the latest VyOS release which is 1.4 at the time.
All new documentation enhancements go to the
master branch. If those changes
are beneficial for previous VyOS documentation versions they will be
cherry-picked to the appropriate branch(es).
Post-1.2.0 branches are named after constellations sorted by area from smallest to largest. There are 88 of them, here's the complete list.
Debian requires some extra steps for
First ensure that Python 2 & Python 3 are installed and Python 3 is the default:
Alternatively, to make Python the default, revise the following line to point at the relevant 3.x version of the binary on your system:
sudo update-alternatives --install /usr/bin/python python /usr/bin/python3 0
Then install the sphinx group of packages:
sudo apt-get install python3-sphinx
Although almost everything uses Python 3, in order to install this specific package, make sure that pip points at the Python 2 version of the package manager:
sudo pip install sphinx-rtd-theme
Do the following to build the HTML and start a web server:
make livehtmlinside the
Then, to view the live output:
- Browse to http://localhost:8000 Note: The changes you save to the sources are represented in the live HTML output automatically (and almost instantly) without the need to rebuild or refresh manually.
Using our Dockerfile you can create your own Docker container that is used to build a VyOS documentation.
You can either build the container on your own or directly fetch it prebuilt from Dockerhub. If you want to build it for yourself, use the following command.
$ docker build -t vyos/vyos-documentation docker
vyos/vyos-documentation container could not be found locally it will be
automatically fetched from Dockerhub.
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \ -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make html # sphinx autobuild $ docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs -e \ GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation make livehtml
Test the docs
Discuss in this Phabricator task: T1731
To test all files run:
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs \ -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos/vyos-documentation vale .
to test a specific file (e.g.
$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) \ -e GOSU_GID=$(id -g) vyos/vyos-documentation vale clustering.rst