- Write to @botfather on telegram and create new bot (save token and set bot username)
- Run with correct values:
npm run init:token --username name_bot --token 1234:asdfghjkl - Run
npm run init - Run
npm run dev - Write
/starton telegram bot.
If you want to replace all strings (example: package name, author, URLs, etc...) in the markdown file, source files and others files of this project you need to edit setup.json with correct values and run npm run setup.
If you want to run the bot using webhooks you need to place your SSL certificate and Private key in the certs directory and configure the webhook object in the config file like:
webhook: {
url: "https://my.host.com:8443", // or DNS name
port: 8443,
selfSigned: true
},If you want to run the bot with your self-signed certificate selfSigned flag needs to be set to true, this will allow us to communicate to Telegram that our webhook server can be trusted. More information about webhooks with self-signed certificates can be found here
you can generate your self-signed certificate using the utility script:
npm run init:certs [common-name]
Replace common-name with the same host-name or IP address you are using in the webhook.url path of the config.js file
Deploy bot to your server and:
- Run with correct values:
npm run init:token --token asdfghjkl - Run init
npm run init - Generate release
npm run release - Start bot
npm run start-pm2
You can also release and run your bot as a Docker container.
docker run ptkdev/ImoovaNotifier:<version>where <version> can be one of the releases (ex. v1.0.0) or latest
For your convenience, in case you would like to run the bot in webhook mode, we have already exposed 8443 port on our docker files.
To change the configuration to match yours, just change the Dockerfile line with the EXPOSE instruction
EXPOSE 8443
in the end, you'll be able to expose the docker port using -p <port>:<host-port> docker parameter.
The preferred way to provide the configuration file is to mount the final configuration under /app/dist/configs/config.js:
docker run -v ${PWD}/app/configs/config.js:/app/dist/configs/config.js ptkdev/ImoovaNotifier:<version>Note: the docker images have been prepared for many architectures but have been tested mainly on amd64 architecture.
Run npm run docs
- Code and Contributions have MIT License
- Images and logos have CC BY-NC 4.0 License
- Documentations and Translations have CC BY 4.0 License