tdesktop/docs/building-linux.md

## Build instructions for Linux using Docker

### Prepare folder

Choose a folder for the future build, for example **/home/user/TBuild**. It will be named ***BuildPath*** in the rest of this document. All commands will be launched from Terminal.

### Obtain your API credentials

You will require **api_id** and **api_hash** to access the Telegram API servers. To learn how to obtain them [click here][api_credentials].

### Clone source code and prepare libraries

Install [poetry](https://python-poetry.org), go to ***BuildPath*** and run

    git clone --recursive https://github.com/telegramdesktop/tdesktop.git
    ./tdesktop/Telegram/build/prepare/linux.sh

### Building the project

Go to ***BuildPath*/tdesktop** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))

    docker run --rm -it \
        -v $PWD:/usr/src/tdesktop \
        tdesktop:centos_env \
        /usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \
        -D TDESKTOP_API_ID=YOUR_API_ID \
        -D TDESKTOP_API_HASH=YOUR_API_HASH

Or, to create a debug build, run (also using [your **api_id** and **api_hash**](#obtain-your-api-credentials))

    docker run --rm -it \
        -v $PWD:/usr/src/tdesktop \
        -e CONFIG=Debug \
        tdesktop:centos_env \
        /usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \
        -D TDESKTOP_API_ID=YOUR_API_ID \
        -D TDESKTOP_API_HASH=YOUR_API_HASH

If you need a backward compatible binary (running on older OS like the official one), you should build the binary with LTO.  
To do this, add `-D CMAKE_INTERPROCEDURAL_OPTIMIZATION=ON` option.

The built files will be in the `out` directory.

[api_credentials]: api_credentials.md
Remove old instructions & patches they referred to (& rename instructions to the actual state) Old instruction names were from the time when tdesktop used GYP that had MSVC, XCode and CMake backends. But tdesktop uses CMake now, so these names are no longer correct. 2021-07-20 02:41:11 +00:00			`## Build instructions for Linux using Docker`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`### Prepare folder`
Don't provide 'api_id' and 'api_hash' by default. We ask the developer to obtain his own api credentials, because the bundled 'api_id' / 'api_hash' are strictly limited by the server. The old credentials still could be used for test purposes, but the developer will need to explicitly opt-in to use them. 2018-11-04 10:29:30 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`Choose a folder for the future build, for example /home/user/TBuild. It will be named *BuildPath* in the rest of this document. All commands will be launched from Terminal.`
Don't provide 'api_id' and 'api_hash' by default. We ask the developer to obtain his own api credentials, because the bundled 'api_id' / 'api_hash' are strictly limited by the server. The old credentials still could be used for test purposes, but the developer will need to explicitly opt-in to use them. 2018-11-04 10:29:30 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`### Obtain your API credentials`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`You will require api_id and api_hash to access the Telegram API servers. To learn how to obtain them [click here][api_credentials].`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`### Clone source code and prepare libraries`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`Install [poetry](https://python-poetry.org), go to *BuildPath* and run`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`git clone --recursive https://github.com/telegramdesktop/tdesktop.git`
			`./tdesktop/Telegram/build/prepare/linux.sh`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Move build to Ubuntu 14.04 and GCC 7.2. To be able to run on the same distributions as before we need to have the same GLIBC version dependency as in Ubuntu 12.04, which is 2.15. For that we need to remove all usages of GLIBC features from 2.16 and above. Currently there are three methods used, so they're wrapped in a separate static library, linux_glibc_wraps. It is a separate library because it must be compiled without '-flto' flag, otherwise the inline __asm__ is not working and we get unresolved symbols. 2017-09-28 09:40:26 +00:00			`### Building the project`
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Invoke linux prepare script the same way. 2023-08-08 11:24:27 +00:00			`Go to **BuildPath/tdesktop and run (using [your api_id and api_hash**](#obtain-your-api-credentials))`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00
Run docker in interactive mode for colored output and Ctrl+C 2021-02-22 22:23:29 +00:00			`docker run --rm -it \`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00			`-v $PWD:/usr/src/tdesktop \`
			`tdesktop:centos_env \`
			`/usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \`
			`-D TDESKTOP_API_ID=YOUR_API_ID \`
Use cmake_dependent_option to better declare variables that relate on other variables 2022-08-10 23:30:32 +00:00			`-D TDESKTOP_API_HASH=YOUR_API_HASH`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00
			`Or, to create a debug build, run (also using [your api_id and api_hash](#obtain-your-api-credentials))`

Run docker in interactive mode for colored output and Ctrl+C 2021-02-22 22:23:29 +00:00			`docker run --rm -it \`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00			`-v $PWD:/usr/src/tdesktop \`
Let specify arbitrary build configuration via Docker Default to RelWithDebInfo for both optimizations and debug information 2024-02-06 15:12:38 +00:00			`-e CONFIG=Debug \`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00			`tdesktop:centos_env \`
			`/usr/src/tdesktop/Telegram/build/docker/centos_env/build.sh \`
			`-D TDESKTOP_API_ID=YOUR_API_ID \`
Use cmake_dependent_option to better declare variables that relate on other variables 2022-08-10 23:30:32 +00:00			`-D TDESKTOP_API_HASH=YOUR_API_HASH`
Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00
Explain how to build a backward compatible binary on Linux 2022-11-08 17:11:28 +00:00			`If you need a backward compatible binary (running on older OS like the official one), you should build the binary with LTO.`
			To do this, add `-D CMAKE_INTERPROCEDURAL_OPTIMIZATION=ON` option.

Update Linux build instructions Co-authored-by: Ilya Fedin <fedin-ilja2010@ya.ru> 2020-12-13 06:16:37 +00:00			The built files will be in the `out` directory.
Moved all builds to GYP. 2016-09-12 11:45:41 +00:00
Don't provide 'api_id' and 'api_hash' by default. We ask the developer to obtain his own api credentials, because the bundled 'api_id' / 'api_hash' are strictly limited by the server. The old credentials still could be used for test purposes, but the developer will need to explicitly opt-in to use them. 2018-11-04 10:29:30 +00:00			`[api_credentials]: api_credentials.md`