Skip to content

About

The shared core of olcOS: the olcrtc tunnel, the Go code both apps bind with gomobile, and the server scripts

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

olcos-core

Общее ядро приложений olcOS для iPhone и Android: туннель olcrtc, код на Go, который приложения
собирают через gomobile, и скрипты, которые ставят сервер.

Important

Хотите просто установить приложение? Здесь только исходный код ядра. Готовые файлы и пошаговая инструкция лежат в главном репозитории olcOS и на сайте.

Сайт · Инструкция · iOS · Android · English

Что это

olcOS помогает обойти белые списки мобильного интернета: телефон и ваш сервер заходят в один видеозвонок (VK Звонки, Яндекс Телемост, SaluteJazz, МТС Линк, Jitsi) и передают трафик внутри него. Всё, что для этого не зависит от конкретного телефона, лежит здесь. Приложения для iOS и для Android подключают этот репозиторий как подмодуль olcos-core/ и добавляют к нему только интерфейс и системную часть VPN.

Что внутри

Папка Что там
olcrtc/ ядро olcrtc (Apache-2.0) на релизе из olcrtc.upstream и изменения olcOS поверх него отдельными коммитами
mobile/ модуль для gomobile: tun2socks (tunstack), склейка комнат в режиме «Весь сервер» (bond) и агент сервера (agent)
engine/, profile/, olcos/ общий интерфейс движков, разбор ссылок olcrtc:// и vless://, движок Xray
server/ установка olcrtc на сервер (srv.sh), установщик одной командой (install.sh), Xray, скрипты агента и патч ядра для сервера
scripts/ сборка для iOS и Android, генерация патча, обновление olcrtc, проверки
docs/ устройство и как устроен olcrtc здесь

Оба приложения собирают ядро одним вызовом gomobile: два Go-фреймворка нельзя положить в одно приложение, у каждого свой рантайм. Сервер собирает то же ядро из olcrtc нужного коммита и патча server/olcrtc-core.patch, а приложения сверяют версию ядра на сервере со своей и предлагают обновить его, если они расходятся.

Сервер одной командой

На чистом VPS с Debian, Ubuntu, Fedora или CentOS под root:

curl -fsSL https://raw.githubusercontent.com/olcOS/olcos/main/install.sh | sudo bash

Команда из главного репозитория скачивает server/install.sh отсюда, ставит olcrtc и агента и печатает приглашение. Его нужно отсканировать в olcOS, и телефон станет владельцем сервера. Настройки описаны в начале server/install.sh.

Сборка

Нужен Go версии из mobile/go.mod.

git clone https://github.com/olcOS/olcos-core
cd olcos-core
scripts/build-ios.sh          # macOS и Xcode, результат: build/Mobile.xcframework
scripts/build-android.sh      # JDK, Android SDK и NDK, результат: build/olcoscore.aar

Проверки, которые запускает CI:

go test ./...                              # движки и профили
(cd mobile && go test ./...)               # tunstack, склейка, агент
python3 scripts/parity_check.py            # srv.sh не отстал от olcrtc/install.sh
scripts/make-core-patch.sh --check         # патч сервера совпадает с olcrtc/
python3 scripts/test_server_scripts.py
python3 scripts/test_xray_server_script.py

Изменения в olcrtc и обновление

Правки в olcrtc/ делаются обычными коммитами, после них нужно перегенерировать патч сервера. Новый релиз olcrtc подтягивается одной командой scripts/update-olcrtc.sh <тег>. Подробности и ограничения в docs/olcrtc.md.

Ошибки и безопасность

Ошибки приложений описывайте в Issues главного репозитория, ошибки ядра и скриптов сервера можно и здесь. Не публикуйте ссылки подключения, ключи и адреса своих серверов. Об уязвимостях сообщайте приватно, см. SECURITY.md.

Лицензия

Код olcOS распространяется по лицензии MIT. Каталог olcrtc/ распространяется по Apache-2.0, см. olcrtc/LICENSE и olcrtc/NOTICE. Сторонние компоненты перечислены в NOTICE.

About

The shared core of olcOS: the olcrtc tunnel, the Go code both apps bind with gomobile, and the server scripts

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages