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

Update server.rst #156

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update server.rst #156

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 15 additions & 1 deletion docs/server.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ Also the following Debian packages are required:
* ``python-dev``
* ``libevent-dev``

Debian 10 required following packages:
Copy link
Member

Choose a reason for hiding this comment

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

If we give a distro here, we should also give a distro above -- or replace the above list.

* ``iproute2``
* ``bridge-utils``
* ``python-dev``
* ``libevent-dev``
* ``libnetfilter-conntrack-dev``
Copy link
Member

Choose a reason for hiding this comment

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

This packet is not required any more as far as I know -- we do not have it installed on our servers and tunneldigger works fine there.


If you would like to use the already supplied hook scripts to setup the network
interfaces, you also need the following packages:

Expand All @@ -133,6 +140,10 @@ You can install all of the above simply by running on Debian::

sudo apt-get install iproute bridge-utils python-dev libevent-dev ebtables python-virtualenv

and Debian 10::

sudo apt install iproute2 libnetfilter-conntrack-dev bridge-utils python-dev libevent-dev ebtables python-virtualenv

and for Fedora you can use this command::

sudo yum install iproute bridge-utils python-devel libevent-devel ebtables libnl-devel python-pip python-virtualenv
Expand All @@ -147,7 +158,7 @@ If we assume that you are installing Tunneldigger under ``/srv/tunneldigger``
virtualenv -p /usr/bin/python3 env_tunneldigger

.. note::
Tunneldigger only supports Python 3.
Latest Tunneldigger only supports Python 3.
Copy link
Author

Choose a reason for hiding this comment

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

It's confusing, because the "stable" version shown as v0.3.0 is working under python 2.7.

Maybe someone can delete the "stable" read the docs version or update this? how can something be stable if it runs under python 2.7?

Copy link
Member

Choose a reason for hiding this comment

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

I think this is related to #145?

Copy link
Member

@RalfJung RalfJung Oct 18, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I don't think docs should retrace the history of all things that used to be supported in the past. Also, everything the docs say only applies to latest tunneldigger. It would be more confusing to emphasize this here as that might be read to imply that some of the rest of the docs also apply to older tunneldigger, which they do not. (They might happen to, but that is a coincidence. These are docs for the latest version and the latest version only.)


Using the above command ensures the virtualenv is created using a Python 3 interpreter.
In case the Python 3 interpreter you would like to use is not located at ``/usr/bin/python3`` you will have to adjust the path accordingly.
Expand All @@ -160,6 +171,9 @@ You can then checkout the Tunneldigger repository into ``/srv/tunneldigger/tunne
cd /srv/tunneldigger
git clone https://github.com/wlanslovenija/tunneldigger.git

.. note::
You may need to checkout another branch (legacy) and check requirements. For details please look at "Operating System" and "System Packages"

Next you have to enter the environment and install the broker alongside its dependencies::

source env_tunneldigger/bin/activate
Expand Down