SaltyRTC Signalling Server
This is a SaltyRTC server implementation for Python 3.4+ using asyncio.
On machines where Python 3 is not the default Python runtime, you should
pip3 instead of
$ sudo apt-get install python3 python3-pip
We recommend using venv to create an isolated Python environment:
$ pyvenv venv
You can switch into the created virtual environment venv by running this command:
$ source venv/bin/activate
While the virtual environment is active, all packages installed using
pip will be installed into this environment.
To deactivate the virtual environment, just run:
If you want easier handling of your virtualenvs, you might also want to take a look at virtualenvwrapper.
If you are using a virtual environment, activate it first.
Install the module by running:
$ pip install saltyrtc.server
libnacl will be installed automatically. However, you
may need to install libsodium for
libnacl to work.
Command Line Usage
saltyrtc-server will be automatically installed and
provides a command line interface for the server. Run the following
command to see usage information:
$ saltyrtc-server --help
If you want to contribute to this project, you should install the
dev requirements of the project in an editable environment:
$ git clone https://github.com/saltyrtc/saltyrtc-server-python.git $ cd saltyrtc-server-python $ pip install -e .[dev]
Before creating a pull request, it is recommended to run the following
commands to check for code style violations (
isort) and run the project's tests:
$ flake8 . $ isort -rc . $ py.test
Reporting Security Issues
Please report security issues directly to one or both of the following contacts: