251 lines
7.6 KiB
ReStructuredText
251 lines
7.6 KiB
ReStructuredText
|
- `jabbergram <#jabbergram>`__
|
||
|
|
- `English <#english>`__
|
||
|
|
|
||
|
|
- `About <#about>`__
|
||
|
|
- `Installation <#installation>`__
|
||
|
|
- `Configuration <#configuration>`__
|
||
|
|
- `Usage <#usage>`__
|
||
|
|
- `License <#license>`__
|
||
|
|
|
||
|
|
- `Castellano <#castellano>`__
|
||
|
|
|
||
|
|
- `Acerca de <#acerca-de>`__
|
||
|
|
- `Instalación <#instalación>`__
|
||
|
|
- `Configuración <#configuración>`__
|
||
|
|
- `Uso <#uso>`__
|
||
|
|
- `Licencia <#licencia>`__
|
||
|
|
|
||
|
|
jabbergram
|
||
|
|
==========
|
||
|
|
|
||
|
|
English
|
||
|
|
-------
|
||
|
|
|
||
|
|
About
|
||
|
|
~~~~~
|
||
|
|
|
||
|
|
With this program, it's possible to use a MuC ``XMPP`` room to talk to a
|
||
|
|
group on ``Telegram`` and vice versa. The aim of this program is to be
|
||
|
|
just a simple gateway, just pass text from one way to the other. Once
|
||
|
|
it's stable, it probably won't have more improvements, since I don't
|
||
|
|
need them.
|
||
|
|
|
||
|
|
Installation
|
||
|
|
~~~~~~~~~~~~
|
||
|
|
|
||
|
|
As with any program that uses python, it should be used a virtual
|
||
|
|
environment (virtualenv), but that is user selectable. It's possible to
|
||
|
|
use one of the next installation methods:
|
||
|
|
|
||
|
|
Install via pip:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
$ su -c "pip3 install jabbergram"
|
||
|
|
|
||
|
|
Clone the repository:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
$ git clone git://daemons.cf/jabbergram
|
||
|
|
$ cd jabbergram
|
||
|
|
$ su -c "pip3 install -r requirements.txt"
|
||
|
|
$ su -c "python3 setup.py install"
|
||
|
|
|
||
|
|
Configuration
|
||
|
|
~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
This program is simple, it even doesn't have a ``help`` menu. First
|
||
|
|
thing you need to do is to create ``Telegram`` Bot. To do so, you must
|
||
|
|
have a telegram account and talk to
|
||
|
|
`BotFather <https://telegram.me/botfather>`__. Then, execute:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
/start
|
||
|
|
/newbot
|
||
|
|
YourNameBot # ended in bot, always
|
||
|
|
# then it will show your bot token, save it
|
||
|
|
/setprivacy
|
||
|
|
YourNameBot
|
||
|
|
# now press Disable
|
||
|
|
|
||
|
|
The ``/setprivacy`` option is to make the bot read all what it's said to
|
||
|
|
him, not only when using commands. It's necessary to make ``jabbergram``
|
||
|
|
work. More info on creating ``Telegram`` bots at their
|
||
|
|
`webpage <https://core.telegram.org/bots>`__.
|
||
|
|
|
||
|
|
Then, you will have to create a config file. We'll call it
|
||
|
|
``config.ini``. In that file, enter the next parameters:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
[config]
|
||
|
|
jid = exampleJid@nope.org
|
||
|
|
password = difficultPassword
|
||
|
|
muc_room = exampleMuc@muc.nope.org
|
||
|
|
nick = jabbergram
|
||
|
|
token = jabbergramBotTokken
|
||
|
|
group = -10293943920
|
||
|
|
|
||
|
|
The only thing worth mentioning is the ``token`` section, which is said
|
||
|
|
to you when creating the bot, and the ``group``, that is the
|
||
|
|
``Telegram`` group ID.
|
||
|
|
|
||
|
|
There's no easy way to see this from telegram, so you can use the
|
||
|
|
separate utility called ``seeIdGroups.py``. To execute it, you only need
|
||
|
|
to set the ``token`` parameter in the config file. You will need that
|
||
|
|
somebody invite the bot to the group. Also, people on that group must
|
||
|
|
send some messages, so the utility can grab it's id. It may take a
|
||
|
|
couple. When you have the group ID you want, just press Ctrl-c, copy it
|
||
|
|
to the config file (even the minus symbol), and the configuration will
|
||
|
|
be done.
|
||
|
|
|
||
|
|
Usage
|
||
|
|
~~~~~
|
||
|
|
|
||
|
|
You can create all config files you want. You will only need to pass it
|
||
|
|
as parameter, but if you don't it will try to grab ``config.ini`` by
|
||
|
|
default, and it will fail if it doesn't exist:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
# it's advisable to use tmux or screen to execute the next order
|
||
|
|
$ jabbergram.py example.ini
|
||
|
|
|
||
|
|
License
|
||
|
|
~~~~~~~
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
This program is free software: you can redistribute it and / or modify
|
||
|
|
it under the terms of the GNU General Public License as published by
|
||
|
|
the Free Software Foundation, Either version 3 of the License, or
|
||
|
|
(At your option) any later version.
|
||
|
|
|
||
|
|
This program is distributed in the hope That it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU General Public License
|
||
|
|
Along With This Program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
|
||
|
|
Castellano
|
||
|
|
----------
|
||
|
|
|
||
|
|
Acerca de
|
||
|
|
~~~~~~~~~
|
||
|
|
|
||
|
|
Con este programa, es posible utilizar una sala ``XMPP`` para hablar con
|
||
|
|
un grupo de ``Telegram`` y viceversa. El objetivo de este programa es el
|
||
|
|
de ser sólo una pasarela sencilla, sólo tiene que pasar el texto de un
|
||
|
|
lado al otro. Una vez que sea estable, probablemente no tendrá más
|
||
|
|
mejoras, ya que yo no las necesito.
|
||
|
|
|
||
|
|
Instalación
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
Como con cualquier programa escrito en ``Python``, deberia ser usado en
|
||
|
|
un entorno virtual (virtualenv), pero eso queda a la elección del
|
||
|
|
usuario. Es posible utilizar uno de los siguientes métodos de
|
||
|
|
instalación:
|
||
|
|
|
||
|
|
Instalar a través de ``pip``:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
$ su -c "pip3 instalar jabbergram"
|
||
|
|
|
||
|
|
Clonar el repositorio:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
$ git clone git: //daemons.cf/jabbergram
|
||
|
|
$ cd jabbergram
|
||
|
|
$ su -c "pip3 instalar requirements.txt -r"
|
||
|
|
$ su -c "python3 setup.py instalar"
|
||
|
|
|
||
|
|
Configuración
|
||
|
|
~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
Este programa es simple, no tiene ni un menú de ``ayuda``. Lo primero
|
||
|
|
que hay que hacer es crear el bot de ``Telegrama``. Para ello, hay que
|
||
|
|
tener una cuenta de ``Telegram`` y hablar con
|
||
|
|
`BotFather <https://telegram.me/botfather>`__. A continuación, ejecuta:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
/comienzo
|
||
|
|
/newbot
|
||
|
|
NombreDelBot # terminado en bot, siempre
|
||
|
|
# A continuación, se mostrará el token del bot, hay que guardarlo
|
||
|
|
/setprivacy
|
||
|
|
NombreDelBot
|
||
|
|
# Ahora hay que pulsar desactivar
|
||
|
|
|
||
|
|
La opción ``/setprivacy`` es para hacer que el robot pueda leer todo lo
|
||
|
|
que se dice en el grupo, no sólo cuando se utilizan los comandos. Es
|
||
|
|
necesario para hacer que ``jabbergram`` funcione. Más información sobre
|
||
|
|
la creación los bots de ``Telegrama`` en su `página
|
||
|
|
web <https://core.telegram.org/bots>`__.
|
||
|
|
|
||
|
|
A continuación, hay que crear un archivo de configuración, que
|
||
|
|
llamaremos ``config.ini``. En ese archivo, introduce los siguientes
|
||
|
|
parámetros:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
[Config]
|
||
|
|
JID = exampleJid@nope.org
|
||
|
|
password = difficultPassword
|
||
|
|
muc_room = exampleMuc@muc.nope.org
|
||
|
|
nick = jabbergram
|
||
|
|
token = jabbergramBotTokken
|
||
|
|
group = -10,293,943,920
|
||
|
|
|
||
|
|
La única cosa que vale la pena mencionar es la sección del ``token``
|
||
|
|
(que es la que nos da cuando se crea el robot) y el ``group``, que es ID
|
||
|
|
del grupo de ``Telegram``.
|
||
|
|
|
||
|
|
No hay manera fácil de ver el ID desde ``Telegram``, por lo que se puede
|
||
|
|
utilizar el programa llamado ``seeIdGroups.py``. Para ejecutarlo sólo es
|
||
|
|
necesario establecer el parámetro ``token`` del archivo de
|
||
|
|
configuración. Necesitarás que alguien invite al bot al grupo. Además,
|
||
|
|
las personas de ese grupo deben enviar algunos mensajes, para que el
|
||
|
|
programa pueda coger su ID. Puede llevar unos segundos el que aparezcan
|
||
|
|
los mensajes. Cuando se tenga el ID de grupo que se quiere, sólo hay que
|
||
|
|
pulsar Ctrl-c, copiarlo en el archivo de configuración (incluido el
|
||
|
|
simbolo menos), y la configuración estará terminada.
|
||
|
|
|
||
|
|
Uso
|
||
|
|
~~~
|
||
|
|
|
||
|
|
Se pueden crear todos los archivos de configuración que se deseen. Sólo
|
||
|
|
tendrás que pasarlo como parámetro al programa, si no se hace se
|
||
|
|
intentará coger el archivo ``config.ini`` por defecto, y se producirá un
|
||
|
|
error si no existe:
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
# Es recomendable utilizar tmux o la pantalla para ejecutar la siguiente orden
|
||
|
|
$ Jabbergram.py example.ini
|
||
|
|
|
||
|
|
Licencia
|
||
|
|
~~~~~~~~
|
||
|
|
|
||
|
|
::
|
||
|
|
|
||
|
|
This program is free software: you can redistribute it and / or modify
|
||
|
|
it under the terms of the GNU General Public License as published by
|
||
|
|
the Free Software Foundation, Either version 3 of the License, or
|
||
|
|
(At your option) any later version.
|
||
|
|
|
||
|
|
This program is distributed in the hope That it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU General Public License
|
||
|
|
Along With This Program. If not, see <http://www.gnu.org/licenses/>.
|