https://github.com/tsuk1ko/cfworker-middleware-telegraf

Make telegraf (a telegram bot framework) useable in Cloudflare Workers
https://github.com/tsuk1ko/cfworker-middleware-telegraf

cfworker cloudflare cloudflare-workers telegraf telegram telegram-bot

Last synced: 3 months ago
JSON representation

Make telegraf (a telegram bot framework) useable in Cloudflare Workers

• Host: GitHub
• URL: https://github.com/tsuk1ko/cfworker-middleware-telegraf
• Owner: Tsuk1ko
• License: mit
• Archived: true
• Created: 2020-05-14T15:25:19.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-31T13:56:10.000Z (over 2 years ago)
• Last Synced: 2024-10-27T05:08:37.045Z (3 months ago)
• Topics: cfworker, cloudflare, cloudflare-workers, telegraf, telegram, telegram-bot
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cfworker-middleware-telegraf
• Size: 50.8 KB
• Stars: 64
• Watchers: 3
• Forks: 14
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cfworker-middleware-telegraf

[![Version](https://img.shields.io/npm/v/cfworker-middleware-telegraf.svg?style=flat-square)](https://www.npmjs.com/package/cfworker-middleware-telegraf)

Make [telegraf](https://github.com/telegraf/telegraf) (a telegram bot framework) useable in [Cloudflare Workers](https://workers.cloudflare.com/).

You can use [cfworker-telegraf-template](https://github.com/Tsuk1ko/cfworker-telegraf-template) directly.

> v2 only support for telegraf@4. If you want to use telegraf@3, please downgrade to v1.

## Installation

```bash

npm i cfworker-middleware-telegraf

```

## Usage

### 0. Install dependencies

Here we use webpack 5.

```bash

npm i @cfworker/web telegraf cfworker-middleware-telegraf

npm i -D webpack webpack-cli node-polyfill-webpack-plugin

```

### 1. Write your code

```js

// index.js

const { Telegraf } = require('telegraf');

const { Application, Router } = require('@cfworker/web');

const createTelegrafMiddleware = require('cfworker-middleware-telegraf');

const bot = new Telegraf(self.BOT_TOKEN);

// Your code here, but do not `bot.launch()`

// Do not forget to set environment variables BOT_TOKEN and SECRET_PATH on your worker

const router = new Router();

router.post(`/${self.SECRET_PATH}`, createTelegrafMiddleware(bot));

new Application().use(router.middleware).listen();

```

### 2. Webpack your code and upload to cfworker

```js

// webpack.config.js

const path = require('path');

const NodePolyfillPlugin = require('node-polyfill-webpack-plugin');

module.exports = {

  entry: path.resolve(__dirname, 'index.js'),

  target: 'webworker',

  output: {

    filename: 'worker.js',

    path: path.resolve(__dirname, 'dist'),

  },

  mode: 'production',

  resolve: {

    fallback: {

      fs: false,

    },

  },

  plugins: [new NodePolyfillPlugin()],

  performance: {

    hints: false,

  },

};

```

```bash

npx webpack -c webpack.config.js

```

Just copy and paste built code `dist/worker.js` to cfworker online editor and save.

Or you can use [Wrangler](https://developers.cloudflare.com/workers/cli-wrangler), an official CLI tool, so you don't need to copy and paste code manually anymore. But I don't like it due to its inexplicable bugs on Win10.

### 3. Set telegram bot webhook

These codes only need to be run once locally.

```js

const { Telegraf } = require('telegraf');

const bot = new Telegraf('YOUR_BOT_TOKEN');

(async () => {

  // set webhook

  await bot.telegram.setWebhook('https://your.cfworker.domain/YOUR_SECRET_PATH');

  // delete webhook

  // await bot.telegram.deleteWebhook();

  // get webhook info

  await bot.telegram.getWebhookInfo().then(console.log);

})();

```