ppn/olcrtc
3
0
Fork 0
mirror of https://github.com/openlibrecommunity/olcrtc.git synced 2026-07-03 14:05:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add english readme with language switcher

Browse Source
This commit is contained in:
neuronori
2026-06-28 16:40:25 +00:00
parent 91ed03f3d3
commit 9c05dc6ec3
2 changed files with 112 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
readme.en.md
+110
View File
@@ -0,0 +1,110 @@
<div align="center">
![Westand](docs/asset/westand.svg)
<img src="https://github.com/openlibrecommunity/material/blob/master/olcrtc.png" width="250" height="250">
![License](https://img.shields.io/badge/license-WTFPL-0D1117?style=flat-square&logo=open-source-initiative&logoColor=green&labelColor=0D1117)
![Golang](https://img.shields.io/badge/-Golang-0D1117?style=flat-square&logo=go&logoColor=00A7D0)
[Русский](readme.md) | **English**
</div>
# olcRTC
`olcRTC` (OpenLibreCommunity RTC) is an encrypted TCP-over-WebRTC tunnel. Traffic is disguised as an ordinary video call on allowed services (Jitsi, Yandex Telemost, WbStream). Inside there is XChaCha20-Poly1305 encryption and smux multiplexing over WebRTC data/video channels.
Status: **Beta**
```text
app -> SOCKS5 -> olcrtc cnc -> WebRTC/SFU service -> olcrtc srv -> internet
```
> **Important:** make sure the video call service you need is on the allow lists and works in your network. If not, use another one.
## Features
- **Providers:** `jitsi`, `telemost`, `wbstream`
- **Transports:** `datachannel`, `vp8channel`, `seichannel`, `videochannel`
- **Platforms:** Linux, macOS, Windows, Android (gomobile), embeddable Go library
Recommended start: `jitsi + datachannel`.
## Quick start
You need Go 1.26+ and mage.
```sh
go install github.com/magefile/mage@latest
git clone https://github.com/openlibrecommunity/olcrtc --recurse-submodules
cd olcrtc
mage build
```
Generate a shared key (the same on server and client):
```sh
openssl rand -hex 32
```
Run the server and the client with YAML configs:
```sh
./build/olcrtc-linux-amd64 server.yaml
./build/olcrtc-linux-amd64 client.yaml
```
The client starts a local SOCKS5 on `127.0.0.1:8808`. Check:
```sh
curl --socks5-hostname 127.0.0.1:8808 https://icanhazip.com
```
Full instructions and config examples are in [docs/fast.md](docs/fast.md) and [docs/configuration.md](docs/configuration.md).
## Documentation
| Document | Contents |
|---|---|
| [about.md](docs/about.md) | architecture, providers, transports, public API |
| [fast.md](docs/fast.md) | quick start for newcomers |
| [manual.md](docs/manual.md) | manual build |
| [configuration.md](docs/configuration.md) | YAML setup |
| [settings.md](docs/settings.md) | compatibility matrix |
| [uri.md](docs/uri.md) | client URI format |
| [sub.md](docs/sub.md) | subscription format |
## Build
```sh
mage build # current platform
mage cross # cross-compilation
mage test # tests
mage lint # golangci-lint
mage mobile # gomobile bindings (Android)
```
`videochannel` requires `ffmpeg`.
## Community
- Telegram: [@openlibrecommunity](https://t.me/openlibrecommunity)
- Issues: [github.com/openlibrecommunity/olcrtc/issues](https://github.com/openlibrecommunity/olcrtc/issues)
- Community UI client: [alananisimov/olcbox](https://github.com/alananisimov/olcbox)
## License
WTFPL
<div align="center">
---
Telegram: [zarazaex](https://t.me/zarazaexe)
<br>
Email: [zarazaex@tuta.io](mailto:zarazaex@tuta.io)
<br>
Site: [zarazaex.xyz](https://zarazaex.xyz)
</div>
readme.md
+2
View File
@@ -7,6 +7,8 @@
![License](https://img.shields.io/badge/license-WTFPL-0D1117?style=flat-square&logo=open-source-initiative&logoColor=green&labelColor=0D1117)
![Golang](https://img.shields.io/badge/-Golang-0D1117?style=flat-square&logo=go&logoColor=00A7D0)
**Русский** | [English](readme.en.md)
</div>
# olcRTC