Skip to content

aryanvikash/teledaxapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Teledax Api

Open Source Love GPLv3 license

Deploy Guide

  • Clone to local machine.
$ git clone https://github.com/aryanvikash/teledaxapi.git
$ cd teledaxapi
  • Create and activate virtual environment.
$ pip3 install virtualenv
$ virtualenv venv
$ source venv/bin/activate
  • Install dependencies.
$ pip3 install -U -r requirements.txt
  • Environment Variables.
Variable Name Value
API_ID (required) Telegram api_id obtained from https://my.telegram.org/apps.
API_HASH (required) Telegram api_hash obtained from https://my.telegram.org/apps.
INDEX_SETTINGS (required) See the below description.
SESSION_STRING (required) String obtained by running $ python3 app/generate_session_string.py. (Login with the telegram account which is a participant of the given channel (or chat).

| PORT (optional) | Port on which app should listen to, defaults to 8080. | | HOST (optional) | Host name on which app should listen to, defaults to 0.0.0.0. | | DEBUG (optional) | Give some value to set logging level to debug, info by default. |

  • Setting value for INDEX_SETTINGS

This is the general format, change the values of corresponding fields as your requirements.

{
    "index_all": true,
    "index_private":false,
    "index_group": false,
    "index_channel": true,
    "exclude_chats": [],
    "include_chats": [],
}
  • index_all - Whether to consider all the chats associated with the telegram account. Value should either be true or false.
  • index_private - Whether to index private chats. Only considered if index_all is set to true. Value should either be true or false.
  • index_group - Whether to index group chats. Only considered if index_all is set to true. Value should either be true or false.
  • index_channel - Whether to index channels. Only considered if index_all is set to true. Value should either be true or false.
  • exclude_chats - An array/list of chat id's that should be ignored for indexing. Only considered if index_all is set to true.
  • include_chats - An array/list of chat id's to index. Only considered if index_all is set to false.
  • Run app.
$ python3 -m app
  • Other quick methods.

Deploy Run on Repl.it

Contributions

Contributions are welcome.

Credit ❤️

original repo is created by @odysseusmax.

License

Code released under The GNU General Public License.

About

Api For Teledax Client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages