From e21fd4da62feb307c86ca0e8b1c0e20235e565e5 Mon Sep 17 00:00:00 2001 From: infactum Date: Fri, 1 Mar 2019 23:54:01 +0500 Subject: [PATCH] readme update --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a804d90..427c487 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,16 @@ Your SIP PBX should be comaptible with `L16@48000` or `OPUS@48000` voice codec. ## Usage -1. Download prebuild versions for supported OS from CI or compile it yourself. -[Ubuntu 18.04 Bionic](https://ci.appveyor.com/api/projects/Infactum/tg2sip/artifacts/tg2sip_bionic.zip?branch=master&job=Environment%3A%20target_name%3DUbuntu%20Bionic%2C%20docker_tag%3Dbionic) -[CentOS 7](https://ci.appveyor.com/api/projects/Infactum/tg2sip/artifacts/tg2sip_centos7.zip?branch=master&job=Environment%3A%20target_name%3DCentOS%207%2C%20docker_tag%3Dcentos7) -Prebuild binaries requires OPUS libraries (`libopus0` for Ubuntu, `opus` for CentOS, etc). +1. Obtain binaries in one of convenient ways for you. + * Build them from source. + Requires C++17 supported comiler, which may be a trouble for old linux distros. + * Download prebuild native binaries for one of supported distros. + [Ubuntu 18.04 Bionic](https://ci.appveyor.com/api/projects/Infactum/tg2sip/artifacts/tg2sip_bionic.zip?branch=master&job=Environment%3A%20target_name%3DUbuntu%20Bionic%2C%20docker_tag%3Dbionic) + [CentOS 7](https://ci.appveyor.com/api/projects/Infactum/tg2sip/artifacts/tg2sip_centos7.zip?branch=master&job=Environment%3A%20target_name%3DCentOS%207%2C%20docker_tag%3Dcentos7) + Prebuild binaries requires OPUS libraries (`libopus0` for Ubuntu, `opus` for CentOS, etc). + * [Download](https://ci.appveyor.com/api/projects/Infactum/tg2sip/artifacts/tg2sip.zip?branch=master&job=Environment%3A%20target_name%3DAppImage2C%20docker_tag%3Dcentos6) universal AppImage package. + More information of what is AppImage can be found here https://appimage.org/ + 2. Obtain `api_id` and `api_hash` tokens from [this](https://my.telegram.org) page and put them in `settings.ini` file. 3. Login into telegram with `gen_db` app 4. Set SIP server settings in `settings.ini` @@ -25,6 +31,9 @@ SIP->Telegram calls can be done using 3 extension types: 2. `\+[\d]+` for calls by phone number 3. `[\d]+` for calls by telegram ID. Only known IDs allowed by telegram API. +All Telegram->SIP calls will be redirected to `callback_uri` SIP-URI that can be set in from `settings.ini` file. +Extra information about caller Telegram account will be added into `X-TG-*` SIP tags. + ## Donate [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=755FZWPRC9YGL&lc=US&item_name=TG2SIP¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)