This is a SaltyRTC server implementation for Python 3.5+ using asyncio.

On machines where Python 3 is not the default Python runtime, you should use pip3 instead of pip.

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:

deactivate

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

The dependency libnacl will be installed automatically. However, you may need to install libsodium for libnacl to work.

The script 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 optional 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 (flake8), optimise imports (isort), do a static type analysis and run the project's tests:

flake8 .
isort -rc .
MYPYPATH=${PWD}/stubs mypy saltyrtc examples
py.test

Please report security issues directly to one or both of the following contacts:

• Danilo Bargen
  • Email: mail@dbrgn.ch
  • Threema: EBEP4UCA
  • GPG: EA456E8BAF0109429583EED83578F667F2F3A5FA
• Lennart Grahl
  • Email: lennart.grahl@gmail.com
  • Threema: MSFVEW6C
  • GPG: 3FDB14868A2B36D638F3C495F98FBED10482ABA6