Skip to main content

The ultimate tool to automate custom telegram message forwarding.

Project description

tgcf logo

tgcf

The ultimate tool to automate custom telegram message forwarding.

GitHub license GitHub stars GitHub issues PyPI Twitter

Code Quality

Live-syncer, Auto-poster, backup-bot, cloner, chat-forwarder, duplicator, ...

Call it whatever you like! tgcf can fulfill your custom needs.

Videos

The following videos (english) explain everything in great detail.

  • Feature Overview
  • Running on Windows/Mac/Linux
  • Running on Android
  • Deploy to Digital Ocean Droplet

Supported environments

  • Linux
  • Mac
  • Windows (Running Ubuntu on top of WSL-2)
  • Android (Using Termux app)
  • Any Linux VPS

Install and Run

If you want to use tgcf for free, then run on your own desktop or mobile computer.

Make sure you are on a supported environment and have python:3.10 or above, installed.

  • Create a directory and move into it.

    mkdir my-tgcf
    cd my-tgcf
    
  • Create a python virtual environment and activate it.

    python3 -m venv .venv
    source .venv/bin/activate
    
  • Install tgcf using pip

    pip install tgcf
    tgcf --version
    
  • Set the password for accessing web interface. The password is to be set in the .env file.

    echo "PASSWORD=hocus pocus qwerty utopia" >> .env
    

    Set your own password, instead of whats given above.

    Security advice:

    • Please make sure the password has more than 16 characters.
    • You can save your password in any password manager (may be of browser) to autofill password everytime.
  • Start the web-server.

    tgcf-web
    

To run tgcf without the web-ui read about tgcf cli.

If you are planning to use watermarking and ocr features within tgcf, you need to install ffmpeg and tesseract-ocr libraries in you system. Read more.

Deploy to Cloud

Click on this link and get free 200$ on Digital Ocean.

DigitalOcean Referral Badge

NOTE You will get nothing if you directly sign up from Digital Ocean Home Page. Use the link above, or click on the big fat button above to get free 200$.

Deploying to a cloud server is an easier alternative if you cannot install on your own machine. Cloud servers are very reliable and great for running tgcf in live mode for a long time.

Here are some guides for deployment to different cloud providers.

Getting Help

  • First of all read the wiki and watch the videos to get started.

  • Type your question in GitHub's Search bar on the top left of this page, and click "In this repository". Go through the issues, discussions and wiki pages that appear in the result. Try re-wording your query a few times before you give up.

  • If your question does not already exist, feel free to ask your questions in the Discussion forum. Please avoid duplicates.

  • For reporting bugs or requesting a new feature please use the issue tracker of the repo.

Contributing

PRs are most welcome! Read the contributing guidelines to get started.

If you are not a developer, you may also contribute financially to incentivise the development of any custom feature you need.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tgcf-1.1.1.tar.gz (24.3 kB view details)

Uploaded Source

Built Distribution

tgcf-1.1.1-py3-none-any.whl (29.8 kB view details)

Uploaded Python 3

File details

Details for the file tgcf-1.1.1.tar.gz.

File metadata

  • Download URL: tgcf-1.1.1.tar.gz
  • Upload date:
  • Size: 24.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.15.68.1-microsoft-standard-WSL2

File hashes

Hashes for tgcf-1.1.1.tar.gz
Algorithm Hash digest
SHA256 a157ea7ac2a7660be50bc1956772f4dc4144f28c3996ff92bb1173c790e665e9
MD5 22e891028dbcc6db37b20b655abfc436
BLAKE2b-256 a13f8333a7590d7783fe25d91058e9b12e40b6ebdaf81db2b1ed19c07842cac5

See more details on using hashes here.

File details

Details for the file tgcf-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: tgcf-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 29.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.1 CPython/3.10.4 Linux/5.15.68.1-microsoft-standard-WSL2

File hashes

Hashes for tgcf-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e096d5d141b42c9f3221a00282dceecd27c97c6c4c5c03b035616f08028e2f71
MD5 f9b04c4403ed152232f9dfff365eee0a
BLAKE2b-256 f79d9e4cb2cb873493906c6769bc8ad51b2855cc52f89e0dfacd43e7e2126528

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page