Welcome to the GeekTG FTG Mod documentation

• Installation


Automated installation

Linux / Termux
(. <($(which curl>/dev/null&&echo curl -Ls||echo wget -qO-) https://raw.githubusercontent.com/GeekTG/Friendly-Telegram/master/install.sh))

Windows
iex (New-Object Net.WebClient).DownloadString("https://raw.githubusercontent.com/GeekTG/Friendly-Telegram/master/install.ps1")

Heroku Windows
iex (New-Object Net.WebClient).DownloadString("https://raw.githubusercontent.com/GeekTG/Friendly-Telegram/master/install-heroku.ps1")

Mac
$(which curl>/dev/null&&echo curl -LsO||echo wget -q) https://raw.githubusercontent.com/GeekTG/Friendly-Telegram/master/install.sh&&(. install.sh --no-web);rm install.sh


Heroku installation

You can directly click Deploy to deploy to Heroku. Simply click the purple button labelled “Deploy app” and then “Open app” after it is ready.

Script
(. <($(which curl>/dev/null&&echo curl -Ls||echo wget -qO-) https://raw.githubusercontent.com/GeekTG/Friendly-Telegram/master/install.sh) --heroku)


Manual installation
Debian-like linux:

Updating and installing requeired packages

sudo apt update -y && sudo apt upgrade && sudo apt install python3 python3-pip git python3-dev libwebp-dev libz-dev libjpeg-dev libopenjp2-7 libtiff5 ffmpeg imagemagick libffi-dev libcairo2 neofetch dialog -y

Clone the source code

cd && git clone https://github.com/GeekTG/Friendly-Telegram && cd Friendly-Telegram

Instal requirements

python3 -m pip install -r requirements.txt

Launch bot

cd ~/Friendly-Telegram && python3 -m friendly-telegram

Termux
pkg install git ffmpeg imagemagick python libjpeg-turbo zlib libwebp libffi libcairo build-essential dialog neofetch -y
git clone https://github.com/GeekTG/Friendly-Telegram
cd Friendly-Telegram
pip install -r requirements.txt
python -m friendly-telegram
Docker installation

Login as root

sudo su

Install docker

apt update && apt install -y curl && curl -Ls https://get.docker.com/ | bash

Pull image

docker pull geektg/friendly-telegram

Run

docker run --restart unless-stopped --name ftg_on_42069 -d -p 42069:8080 --memory="1024m" --cpus="0.9" --pids-limit 100 geektg/friendly-telegram

--memory="1024m" - This is the maximum memory consumption.
--cpus="0.9" - This is the maximum memory consumption.
-p 42069:8080 - Which port to run FTG, 42069 output port, it can be changed. 8080 should not be changed
--pids-limit 100 - Maximum number of processes, forbbing protection
--name ftg_on_42069 - The name of the container, you can set any name


• Userbot autostart


Autostart as a system service (Linux)

Grant superuser rights

sudo su

Create ftg.service file in /etc/systemd/system/

echo "Description=FTG
[Service]
WorkingDirectory=/home/ubuntu/Friendly-Telegram
ExecStart=/usr/bin/python3 -m friendly-telegram
Type=simple
Restart=always
RestartSec=1
User=ubuntu
[Install]
WantedBy=multi-user.target" > /etc/systemd/system/ftg.service

"/home/ubuntu/Friendly-Telegram" - Path to your FTG

"ubuntu" - The user under which the FTG will be launched

Enable service autostart

sudo systemctl enable ftg.service

Start FTG

sudo service ftg start

Stop FTG

sudo service ftg stop

Restart FTG

sudo service ftg restart

Show FTG status

sudo service ftg status