mycorrhiza/help/en/telegram.myco

= Telegram authorization
//This article is intended for wiki administrators.//

If you want, you can let users log in to your wiki using **Telegram**.

Telegram is a proprietary messaging application used by half a billion people. Learn more at [[https://telegram.org]].

== Setting up Telegram integration
In order to enable Telegram authorization, you need to create a Telegram bot and link it with your wiki.

=== Creating a bot
Open the chat with [[https://t.me/botfather | @BotFather]], the bot for creating other bots. Create a new bot there. You will need the bot username and token later. You can set the bot's userpic. It would be great if it matches your wiki's logo.

After creating the bot, send the `/setdomain` command and then send your wiki's domain.

You do not need to actually //host// the bot. It is enough for it just to be created in BotFather. You can also reuse a previously existing bot.

=== Configuring
In `config.ini`, in `[Telegram]` section, fill in the bot's username (without @) and token:

```
[Telegram]
TelegramBotName = your_bot
TelegramBotToken = 0000000000:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
```

Reload the wiki.

If both fields are both set, the engine will enable Telegram authorization.

== Using
On login and register pages there is a blue button. If a user clicks it, they are prompted to give the authorization permission to your bot. The user's @username will be used as wiki username. Telegram users are part of the //editor// user group by default. Telegram users can use the wiki just like everyone else.

== Limitations
* You should host your wiki using a public IP or domain name. Private-hosted (i.e. localhost or LAN) wikis are not supported, obviously.
* Telegram does not support HTTP wikis, you //must// use HTTPS.
** One way of setting up HTTPS is using [[https://certbot.eff.org | certbot]] and a reverse proxy such as [[https://nginx.org | nginx]].
* Telegram users without @username cannot authorize.
* Telegram users with usernames that are already taken on the wiki cannot authorize.
* Overall, this is an experimental feature. Use on your own risk.
Help: Use =headings 2021-11-30 17:58:03 +00:00			`= Telegram authorization`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			`//This article is intended for wiki administrators.//`

			`If you want, you can let users log in to your wiki using Telegram.`

			`Telegram is a proprietary messaging application used by half a billion people. Learn more at [[https://telegram.org]].`

Help: Use =headings 2021-11-30 17:58:03 +00:00			`== Setting up Telegram integration`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			`In order to enable Telegram authorization, you need to create a Telegram bot and link it with your wiki.`

Help: Use =headings 2021-11-30 17:58:03 +00:00			`=== Creating a bot`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			`Open the chat with [[https://t.me/botfather \| @BotFather]], the bot for creating other bots. Create a new bot there. You will need the bot username and token later. You can set the bot's userpic. It would be great if it matches your wiki's logo.`

			After creating the bot, send the `/setdomain` command and then send your wiki's domain.

			`You do not need to actually //host// the bot. It is enough for it just to be created in BotFather. You can also reuse a previously existing bot.`

Help: Use =headings 2021-11-30 17:58:03 +00:00			`=== Configuring`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			In `config.ini`, in `[Telegram]` section, fill in the bot's username (without @) and token:

			```
			`[Telegram]`
			`TelegramBotName = your_bot`
			`TelegramBotToken = 0000000000:AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA`
			```

			`Reload the wiki.`

			`If both fields are both set, the engine will enable Telegram authorization.`

Help: Use =headings 2021-11-30 17:58:03 +00:00			`== Using`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			`On login and register pages there is a blue button. If a user clicks it, they are prompted to give the authorization permission to your bot. The user's @username will be used as wiki username. Telegram users are part of the //editor// user group by default. Telegram users can use the wiki just like everyone else.`

Help: Use =headings 2021-11-30 17:58:03 +00:00			`== Limitations`
Initial l18n support 2021-09-06 17:46:34 +00:00			`* You should host your wiki using a public IP or domain name. Private-hosted (i.e. localhost or LAN) wikis are not supported, obviously.`
Write the Telegram help article 2021-07-24 19:44:01 +00:00			`* Telegram does not support HTTP wikis, you //must// use HTTPS.`
			`** One way of setting up HTTPS is using [[https://certbot.eff.org \| certbot]] and a reverse proxy such as [[https://nginx.org \| nginx]].`
			`* Telegram users without @username cannot authorize.`
			`* Telegram users with usernames that are already taken on the wiki cannot authorize.`
			`* Overall, this is an experimental feature. Use on your own risk.`