This repository has been archived on 2024-05-28. You can view files and clone it, but cannot push or open issues or pull requests.
annelin d1f58a02dc Notification on errors while sending message
Fixed Location messages
Updated config example
Updated README
2019-08-24 14:19:15 +03:00

3.2 KiB


  • Ruby >= 1.9
  • xmpp4r == 0.5.6
  • tdlib-ruby == 2.0 with pre-compiled

There is pre-compiled for Debian Stretch x64 in repository.
For any other distro you need to manually compile tdlib and place to relative lib/ directory (or LD_LIBRARY_PATH).


First of all, you need to create component listener on your Jabber server. For example, for ejabberd in /etc/ejabberd/ejabberd.yml:

    port: 8888  
    module: ejabberd_service  
    access: all  
    shaper_rule: fast  
    ip: ""  
    service_check_from: false  
            password: "secret"

Next, rename config.yml.example to config.yml and edit xmpp section to match your component listener:

	db 'users.db'  
	jid: 'tlgrm.localhost'  
	host: 'localhost'  
	port: 8888  
	secret: 'secret'  
	loglevel: :warn   


It is good idea to obtain Telegram API ID from to remove demo key requests limit, and then edit in config.yml:

        :lib_path: 'lib/'
            :api_id: '845316' # telegram API ID ( #
            :api_hash: '27fe5224bc822bf3a45e015b4f9dfdb7' # telegram API HASH ( #

How to receive files from Telegram

First of all, you need to set up web server that will serve some directory in your filesystem. Example nginx config:

server {
	listen 80;
	server_name tlgrm.localhost;
	location /content {
		alias /var/zhabogram;

You need to set :content: → :path: and :link: config.yml.

Set :path: according to location (for our example it will be /var/zhabogram/content).
Set :link: according to server_name (for our example it will be http://tlgrm.localhost)

How to send files to Telegram chats

You need to setup mod_http_upload for your XMPP server.
For example, for ejabberd in /etc/ejabberd/ejabberd.yml

    docroot: "/var/ejabberd/upload" # this must be a valid path, user ownership and SELinux flags must be set accordingly
    put_url: "https://xmpp.localhost:5443/upload/@HOST@"
    get_url: "https://xmppfiles.localhost/upload/@HOST@"
    access: local
    max_size: 500000000 #500 MByte
    thumbnail: false
    file_mode: "0644"
    dir_mode: "0744"

Then you need to setup nginx proxy that will serve get_url path, because Telegram will not handle URLs with non-default http(s) ports.
Example nginx config:

/``` server { listen 80; listen 443 ssl;

server_name xmppfiles.localhost;

    # SSL settigns #
    keepalive_timeout   60;
    ssl_certificate      /etc/ssl/domain.crt;
    ssl_certificate_key  /etc/ssl/domain.key;
    ssl_protocols SSLv3 TLSv1 TLSv1.1 TLSv1.2;
    ssl_ciphers  "RC4:HIGH:!aNULL:!MD5:!kEDH";
    add_header Strict-Transport-Security 'max-age=604800';

    location / {
        proxy_pass https://xmpp.localhost:5443;


Finally, update `:upload:` in your config.yml to match `server_name` in nginx config.