Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/paullouisageneau/violet

Lightweight STUN/TURN server
https://github.com/paullouisageneau/violet

c coturn ice rfc-5389 rfc-5766 rfc-8489 rfc-8656 stun stun-server turn turn-server webrtc

Last synced: 13 days ago
JSON representation

Lightweight STUN/TURN server

Host: GitHub
URL: https://github.com/paullouisageneau/violet
Owner: paullouisageneau
License: gpl-2.0
Created: 2021-02-14T11:11:15.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-08-06T04:04:36.000Z (3 months ago)
Last Synced: 2024-08-06T06:43:49.386Z (3 months ago)
Topics: c, coturn, ice, rfc-5389, rfc-5766, rfc-8489, rfc-8656, stun, stun-server, turn, turn-server, webrtc
Language: C
Homepage:
Size: 491 KB
Stars: 198
Watchers: 8
Forks: 21
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-webrtc - violet - Lightweight STUN/TURN server. (Stun & Turn / C/C++)

README

        # Violet - Lightweight STUN/TURN server

[![License: GPL v2 or later](https://img.shields.io/badge/License-GPL_v2_or_later-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)

[![Build](https://github.com/paullouisageneau/violet/actions/workflows/build.yml/badge.svg)](https://github.com/paullouisageneau/violet/actions/workflows/build.yml)

[![Docker](https://img.shields.io/docker/v/paullouisageneau/violet/latest?color=2497ed&label=Docker)](https://hub.docker.com/repository/docker/paullouisageneau/violet)

[![Gitter](https://badges.gitter.im/libjuice/violet.svg)](https://gitter.im/libjuice/violet?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![Discord](https://img.shields.io/discord/903257095539925006?logo=discord)](https://discord.gg/jXAP8jp3Nn)

Violet is a lightweight STUN/TURN server ([RFC8489](https://www.rfc-editor.org/rfc/rfc8489.html) and [RFC8656](https://www.rfc-editor.org/rfc/rfc8656.html)) written in C without dependencies, based on [libjuice](https://github.com/paullouisageneau/libjuice).

Violet is licensed under GPLv2 or later, see [LICENSE](https://github.com/paullouisageneau/violet/blob/master/LICENSE).

![Oompa-Loompas rolling Violet, from Charlie and the Chocolate Factory](https://github.com/paullouisageneau/violet/blob/master/image.png?raw=true)

> "Mercy! Save us!" yelled Mrs Beauregarde. "[...] Violet, you’re **turn**ing violet, Violet!" [...]

>

> "Squeeze her," said Mr Wonka. "We've got to squeeze the **juice** out of her immediately."

>

> -- Charlie and the Chocolate Factory, Roald Dahl

## Dependencies

No external dependencies!

## Running with Docker

An image is available on [Docker Hub](https://hub.docker.com/repository/docker/paullouisageneau/violet), running the TURN server with default options is as simple as:

```bash

docker run --network=host paullouisageneau/violet --credentials=USER:PASSWORD

```

Available options can be listed with the `--help` flag:

```bash

docker run paullouisageneau/violet --help

```

## Installing on Arch Linux

Violet is available as a [package on AUR](https://aur.archlinux.org/packages/violet/):

```bash

paru -S violet

sudo systemctl enable --now violet

```

The configuration file is `/etc/violet/violet.conf`

## Building

### Clone repository and submodules

```bash

git clone https://github.com/paullouisageneau/violet.git

cd violet

git submodule update --init --recursive

```

### Build with CMake

```bash

cmake -B build -DCMAKE_BUILD_TYPE=Release

cd build

make -j2

```

```bash

./violet --credentials=USER:PASSWORD

```

You can list available options with the `--help` (or `-h`) flag. You can also load a configuration file:

```bash

./violet -f ../example.conf

```

### Build with Docker

```bash

docker build -t violet .

```

```bash

docker run --network=host violet --credentials=USER:PASSWORD

```

You can list available options with the `--help` flag. You can also load a configuration file:

```bash

docker run \

	--network=host \

	--mount type=bind,source=$(pwd)/example.conf,target=/etc/violet.conf,readonly \

	paullouisageneau/violet --file=/etc/violet.conf

```