Skip to content

Latest commit

 

History

History
328 lines (251 loc) · 9.41 KB

CONTRIBUTING.md

File metadata and controls

328 lines (251 loc) · 9.41 KB

Configure the project

By default, tgt uses the API_HASH and API_ID inside the telegram.toml file to authenticate the user. If you want to use your own API_HASH and API_ID, you should set the following environment variables (you can get them from here or use the default values):

export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"

and then set to false in the app.toml file the following lines (configuration/README show the possible locations of the configuration file):

take_api_id_from_telegram_config = false
take_api_hash_from_telegram_config = false

Build/Run using download-tdlib feature of tdlib-rs

Using the download-tdlib feature of tdlib-rs you do not need to set any environment variable. Thanks to tdlib-rs you can also compile tgt using that feature downloading the tdlib automatically and build the project.

cargo build --features download-tdlib

Note that this way is supported only for the following platforms:

  • Linux x86_64
  • Windows x86_64
  • MacOS x86_64
  • MacOS aarch64

Build/Run using your local TDLib

By default tgt assume that you have the tdlib built and the LOCAL_TDLIB_PATH environment variable set to the path of the tdlib directory.

You can set the LOCAL_TDLIB_PATH environment variable in the .bashrc or .zshrc file:

export LOCAL_TDLIB_PATH="/path/to/tdlib"

To compile the tdlib, you can see the instructions in the Build TDLib section.

Using pkg-config

If you have the tdlib installed in your system, you can use the pkg-config to find the path of the library.

You can set the PKG_CONFIG_PATH environment variable in the .bashrc or .zshrc file:

export PKG_CONFIG_PATH="/path/to/tdlib/lib/pkgconfig:$PKG_CONFIG_PATH"

and then you need to tell linker where to find the library: If you are using Linux, you can set the LD_LIBRARY_PATH environment variable in the .bashrc or .zshrc file:

export LD_LIBRARY_PATH="/path/to/tdlib/lib:$LD_LIBRARY_PATH"

If you are using MacOS, you can set the DYLD_LIBRARY_PATH environment variable in the .bashrc or .zshrc file:

export DYLD_LIBRARY_PATH="/path/to/tdlib/lib:$DYLD_LIBRARY_PATH"

If you are using Windows, you can set the PATH environment variable in the .bashrc or .zshrc file:

export PATH="/path/to/tdlib/bin:$PATH"

Build TDLib

The steps to build TDLib can be found here, for other info check the official repository of TDLib.

About the api_id you can get one form https://my.telegram.org, for other info check the official documentation.

Current supported TDLib version: 1.8.19.

Build TDLib

MacOS (Intel)

xcode-select --install
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install gperf cmake openssl
git clone https://github.com/tdlib/td.git
cd td
git checkout 2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09
rm -rf build
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl/ -DCMAKE_INSTALL_PREFIX:PATH=../tdlib ..
cmake --build . --target install
cd ..
cd ..
ls -l td/tdlib

Step 1:

In order to use TDLib in your rust project, copy the td/tdlib directory to the parent folder:

cp -r ~/WHERE_IS_TD/td/tdlib ~/WHERE_IS_TD

Step 2:

Add to the .bashrc:

# Note that this path is there you moved the tdlib directory in the step 1
export PKG_CONFIG_PATH=~/WHERE_IS_TDLIB/tdlib/lib/pkgconfig/:$PKG_CONFIG_PATH
export DYLD_LIBRARY_PATH=~/WHERE_IS_TDLIB/tdlib/lib/:$DYLD_LIBRARY_PATH

# Not correct
# export PKG_CONFIG_PATH=~/WHERE_IS_TD/td/build/pkgconfig/:$PKG_CONFIG_PATH

Step 3:

Add to the .bashrc:

# Warning: The API_HASH and API_ID are takern from the Telegram API
export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"

Windows

  • Note that Windows Subsystem for Linux (WSL) and Cygwin are not Windows environments, so you need to use instructions for Linux for them instead.
  • Download and install Microsoft Visual Studio. Enable C++ support while installing.
  • Download and install CMake; choose "Add CMake to the system PATH" option while installing.
  • Download and install Git.
  • Download and install pkg-config.
  • Close and re-open PowerShell if the PATH environment variable was changed.

Run these commands in PowerShell to build TDLib and to install it to td/tdlib:

git clone https://github.com/tdlib/td.git
cd td
git checkout 2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09
git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
git checkout cd5e746ec203c8c3c61647e0886a8df8c1e78e41
./bootstrap-vcpkg.bat
./vcpkg.exe install gperf:x64-windows openssl:x64-windows zlib:x64-windows
cd ..
rm -rf build
mkdir build
cd build
cmake -A x64 -DCMAKE_INSTALL_PREFIX:PATH=../tdlib -DCMAKE_TOOLCHAIN_FILE:FILEPATH=../vcpkg/scripts/buildsystems/vcpkg.cmake ..
cmake --build . --target install --config Release
cd ..
cd ..
ls -l td/tdlib

Step 1:

$env:PATH = $env:PATH + ";/WHERE_IS_TDLIB/tdlib/bin"
$env:PKG_CONFIG_PATH="/WHERE_IS_TDLIB/tdlib/lib/pkgconfig"

Step 2:

# Warning: The API_HASH and API_ID are takern from the Telegram API
$env:API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
$env:API_ID="94575"

Linux Ubuntu22 (using clang)

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install make git zlib1g-dev libssl-dev gperf php-cli cmake clang-14 libc++-dev libc++abi-dev
git clone https://github.com/tdlib/td.git
cd td
git checkout 2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09
rm -rf build
mkdir build
cd build
CXXFLAGS="-stdlib=libc++" CC=/usr/bin/clang-14 CXX=/usr/bin/clang++-14 cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../tdlib ..
cmake --build . --target install
cd ..
cd ..
ls -l td/tdlib

Step 1:

In order to use TDLib in your rust project, copy the td/tdlib directory to the parent folder:

cp -r ~/WHERE_IS_TD/td/tdlib ~/WHERE_IS_TD

Step 2:

Add to the .bashrc:

# Note that this path is there you moved the tdlib directory in the step 1
export PKG_CONFIG_PATH=~/WHERE_IS_TDLIB/tdlib/lib/pkgconfig/:$PKG_CONFIG_PATH
export LD_LIBRARY_PATH=~/WHERE_IS_TDLIB/tdlib/lib/:$LD_LIBRARY_PATH

Step 3:

Add to the .bashrc:

# Warning: The API_HASH and API_ID are takern from the Telegram API
export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"

Linux Arch (using clang)

If you are an Arch Linux user, make sure to have installed:

sudo pacman -S clang14
sudo pacman -S openssl
sudo pacman -S libc++abi
sudo pacman -S libc++
sudo pacman -S libunwind
git clone https://github.com/tdlib/td.git
cd td
git checkout 2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09
rm -rf build
mkdir build
cd build
CXXFLAGS="-stdlib=libc++" CC=/usr/bin/clang CXX=/usr/bin/clang++ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../tdlib ..
cmake --build . --target install
cd ..
cd ..
ls -l td/tdlib

Step 1:

In order to use TDLib in your rust project, copy the td/tdlib directory to the parent folder:

cp -r ~/WHERE_IS_TD/td/tdlib ~/WHERE_IS_TD

Step 2:

Add to the .bashrc:

# Note that this path is there you moved the tdlib directory in the step 1
export PKG_CONFIG_PATH=~/WHERE_IS_TDLIB/tdlib/lib/pkgconfig/:$PKG_CONFIG_PATH
export LD_LIBRARY_PATH=~/WHERE_IS_TDLIB/tdlib/lib/:$LD_LIBRARY_PATH

Step 3:

Add to the .bashrc:

# Warning: The API_HASH and API_ID are takern from the Telegram API
export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"

(OPTIONAL) and then create the following symbolic link:

sudo ln -s /usr/lib/libunwind.so.8.1.0 /usr/lib/libunwind.so.1
sudo ln -s /usr/lib/llvm14/bin/clang++ /usr/bin/clang++-14

and export the following environment variable:

export PATH=$PATH:/usr/lib/llvm14/bin

Linux Other (using clang)

  • Install Git, clang >= 3.4, libc++, make, CMake >= 3.0.2, OpenSSL-dev, zlib-dev, gperf, PHP using your package manager. For example, on Arch Linux, you can run: sudo pacman -S git clang make cmake openssl libc++abi libc++ zlib gperf php.
git clone https://github.com/tdlib/td.git
cd td
git checkout 2589c3fd46925f5d57e4ec79233cd1bd0f5d0c09
rm -rf build
mkdir build
cd build
CXXFLAGS="-stdlib=libc++" CC=/usr/bin/clang CXX=/usr/bin/clang++ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX:PATH=../tdlib ..
cmake --build . --target install
cd ..
cd ..
ls -l td/tdlib

Step 1:

In order to use TDLib in your rust project, copy the td/tdlib directory to the parent folder:

cp -r ~/WHERE_IS_TD/td/tdlib ~/WHERE_IS_TD

Step 2:

Add to the .bashrc:

# Note that this path is there you moved the tdlib directory in the step 1
export PKG_CONFIG_PATH=~/WHERE_IS_TDLIB/tdlib/lib/pkgconfig/:$PKG_CONFIG_PATH
export LD_LIBRARY_PATH=~/WHERE_IS_TDLIB/tdlib/lib/:$LD_LIBRARY_PATH

Step 3:

Add to the .bashrc:

# Warning: The API_HASH and API_ID are takern from the Telegram API
export API_HASH="a3406de8d171bb422bb6ddf3bbd800e2"
export API_ID="94575"