• No need to be added by the channel's admin
• Listen to update events (new message, message edited, message deleted and etc)
• Live forwarding and updating messages
• Flexible mapping of source and target channels/chats (one-to-one, many-to-one, many-to-many)
• Configurable incoming message filters (will be applied to target channels):
  • CompositeMessageFilter - Composite filter that sequentially applies other filters
  • EmptyMessageFilter - Do nothing with message
  • SkipUrlFilter - Skip messages with URLs
  • UrlMessageFilter - URLs filter
  • ForwardFormatFilter - Forward formatting filter
  • MappedNameForwardFormat - Forward formatting filter with mapped channels name
  • KeywordReplaceFilter - Keyword replacing filter
  • SkipAllFilter - Skip all messages filter
  • SkipWithKeywordsFilter - Skip for keywords message text filter
  • RestrictSavingContentBypassFilter - Saving content restriction filter (not ready, PRs are welcome)

0. It's better not to use your main account. Register a new Telegram account

1. Create Telegram App

2. Obtain API_ID and API_HASH

   

3. Setup Postgres database or use InMemoryDatabase with USE_MEMORY_DB=true parameter in .env file

4. Fill .env-example with your data and rename it to .env

   ❗ Note: never push your .env/.yml files with real crendential to a public repo. Use a separate branch (eg, heroku-branch) with .env/.yml files to push to git-based deployment system like Heroku:

   git push heroku heroku-branch:master

   .env-example contains the minimum environment configuration to run with an in-memory database.

   SESSION_STRING can be obtained by running login.py locally (on your PC with installed python 3.9+) with putted API_ID and API_HASH before.

   Channels ID can be fetched by using @messageinformationsbot Telegram bot (just send it a message from the desired channel).

   .env overview

   # Telegram app ID
   API_ID=test
   # Telegram app hash
   API_HASH=test
   # Telegram session string (telethon session, see login.py in root directory)
   SESSION_STRING=test
   # Mapping between source and target channels/chats
   # Channel/chat id can be fetched by using @messageinformationsbot telegram bot
   # Channel id should be prefixed with -100
   # [id1, id2, id3:id4] means send messages from id1, id2, id3 to id4
   # id5:id6 means send messages from id5 to id6
   # [id1, id2, id3:id4];[id5:id6] semicolon means AND
   CHAT_MAPPING=[-100999999,-100999999,-100999999:-1009999999];
   # Remove URLs from incoming messages (true or false). Defaults to false
   REMOVE_URLS=false
   # Comma-separated list of URLs to remove (reddit.com,youtube.com)
   REMOVE_URLS_LIST=google.com,twitter.com
   # Comma-separated list of URLs to exclude from removal (google.com,twitter.com).
   # Will be applied after the REMOVE_URLS_LIST
   REMOVE_URLS_WL=youtube.com,youtu.be,vk.com,twitch.tv,instagram.com
   # Disable mirror message deleting (true or false). Defaults to false
   DISABLE_DELETE=false
   # Disable mirror message editing (true or false). Defaults to false
   DISABLE_EDIT=false
   # Use an in-memory database instead of Postgres DB (true or false). Defaults to false
   USE_MEMORY_DB=false
   # Postgres credentials
   DATABASE_URL=postgres://user:pass@host/dbname
   # or
   DB_NAME=test
   DB_USER=test
   DB_HOST=test
   DB_PASS=test
   # Logging level (debug, info, warning, error or critical). Defaults to info
   LOG_LEVEL=info

   For more flexible configurations (setup directions and filters), use yaml:

   mirror.config.yml overview

   # (Optional) Global filters, will be applied in order
   filters:
     - ForwardFormatFilter: # Filter name under telemirror/messagefilters.py
         format: ""           # Filters arguments
     - EmptyMessageFilter
     - UrlMessageFilter:
         blacklist: !!set
           ? t.me
     - SkipUrlFilter:
         skip_mention: false
   
   # (Optional) Global settings
   disable_edit: true
   disable_delete: true
   
   # (Required) Mirror directions
   directions:
     - from: [-1001, -1002, -1003]
       to: [-100203]
   
     - from: [-100226]
       to: [-1006, -1008]
   
   # (Optional) Targets config
   targets:
       # Config will be applied to target channel with id=-100203
     - id: -100203
       # Overwrite global settings
       disable_edit: false
       disable_delete: false
       # Overwrite global filters
       filters:
         - UrlMessageFilter:
             blacklist: !!set
               ? t.me

5. Make sure the account has joined source and target channels

If you want to bypass forward restriction, see RestrictSavingContentBypassFilter sources to start.

1. Create and activate python virtual environment

   python -m venv myvenv
   source myvenv/Scripts/activate # linux
   myvenv/Scripts/activate # windows

2. Install dependencies

   pip install -r requirements.txt

3. Run

   python main.py