Skip to content
This repository has been archived by the owner on Feb 14, 2020. It is now read-only.

Added instructions to run the server #53

Merged
merged 4 commits into from
Feb 3, 2016
Merged
Changes from all commits
Commits
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
61 changes: 37 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,40 @@

This is the server of Neubot that typically runs on M-Lab servers.

Neubot is a research project on network neutrality of the Nexa
Center for Internet & Society at Politecnico di Torino (DAUIN). The
project is based on a lightweight free software program that interested
users can download and install on their computers. The program runs in
the background and periodically performs transmission tests with
test servers, hosted by the distributed Measurement Lab platform,
and (in future) with other instances of the program itself.
Transmission tests probe the Internet using various application
level protocols and test results are saved both locally and on the
test servers. The results dataset contains samples from various
Providers and is published on the web, allowing anyone to analyze
the data for research purposes.

As a collection Neubot is Copyright (c) 2010-2015 Nexa Center for
Internet & Society, Politecnico di Torino (DAUIN) <http://nexa.polito.it/>.

Each file is copyrighted by the individual contributor.

Neubot collects your Internet address along with the results, and
that is personal data under the European law. For more details
regarding our privacy policy, please refer to the file PRIVACY, in
this directory.

For more info: <http://www.neubot.org/>.
For more info on Neubot in general, see <https://neubot.nexacenter.org/>.

## How to start neubot-server

Currently neubot-server only works on Linux systems. It should also work on
BSD systems, but this was not tested. It does not work on Windows.

In order to start neubot-server you need `root` privileges. They are needed to
bind privileged ports and to assign to user `nobody` read and write permissions
of neubot-server work directory (`/var/lib/neubot`). After ports are bound and
permissions are assigned, neubot-server drops privilegeds and runs as the non
privileged `nobody` user.

Assuming you are in the root directory of neubot-server, you can simply start
the server by running:

```BASH
$ sudo bin/neubot-server-dev
```
In its default configuration, neubot-server output is quite terse; it will only
print the loaded modules implementing one test each. Shortly afterwards, the
server will become a daemon. You can change both verbosity and daemon behavior
by specifying command line options, as follows.

### Options

```BASH
sudo bin/neubot-server-dev [-dv]
```

Accepts the following options:

* `-d ` Do not demonize neubot-server.

* `-v` Makes the command more verbose.