From da48b9023f7e631153189aa0511cb4de1ab4b349 Mon Sep 17 00:00:00 2001
From: Alexey Lepskii <alexey.lepskii@gmail.com>
Date: Sat, 29 Feb 2020 13:27:29 +0300
Subject: [PATCH] Add documentation for using proxy
---
README.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 62 insertions(+)
diff --git a/README.md b/README.md
index 03a6c42..e4337c8 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,68 @@ export class BotService {
See https://github.com/bukhalo/nestjs-telegraf/issues/7#issuecomment-577582322
+### Telegraf use proxy
+
+```typescript
+
+/* bot.config.ts */
+
+import { registerAs } from '@nestjs/config'
+
+interface Config {
+ token: string
+ socksHost: string
+ socksPort: string | number
+ socksUser: string
+ socksPassword: string
+}
+
+export default registerAs(
+ 'bot',
+ (): Config => ({
+ token: process.env.TELEGRAM_BOT_TOKEN,
+ socksHost: process.env.TELEGRAM_BOT_SOCKS_HOST,
+ socksPort: process.env.TELEGRAM_BOT_SOCKS_PORT,
+ socksUser: process.env.TELEGRAM_BOT_SOCKS_USER,
+ socksPassword: process.env.TELEGRAM_BOT_SOCKS_PASS,
+ }),
+);
+
+```
+
+```typescript
+
+/* telegraf-config.service.ts */
+
+import { Injectable } from '@nestjs/common'
+import { ConfigService } from '@nestjs/config'
+import { TelegrafModuleOptions, TelegrafOptionsFactory } from 'nestjs-telegraf'
+import { SocksProxyAgent } from 'socks-proxy-agent'
+
+@Injectable()
+export class TelegrafConfigService implements TelegrafOptionsFactory {
+ private agent
+
+ constructor(private readonly configService: ConfigService) {}
+
+ createTelegrafOptions(): TelegrafModuleOptions {
+ const proxyConfig = {
+ host: this.configService.get('bot.socksHost'),
+ port: this.configService.get('bot.socksPort'),
+ userId: this.configService.get('bot.socksUser'),
+ password: this.configService.get('bot.socksPassword'),
+ }
+ this.agent = new SocksProxyAgent(proxyConfig)
+
+ return {
+ token: this.configService.get('bot.token'),
+ telegrafOptions: { telegram: { agent: this.agent } },
+ };
+ }
+}
+
+```
+
### Telegram
#### Telegram methods usage