Comenzando

Unos pasos sencillos para empezar a utilizar la plataforma EFB.

Instala el EH Forwarder Bot

EH Forwarder Bot puede ser instalado de las siguientes maneras:

Instala desde PyPI

Por defecto pip instala la última versión disponible de PyPI, pero las versiones en desarrollo también están disponibles en PyPI.

pip3 install ehforwarderbot

Instalación desde GitHub

Esto instalará el último commit disponible en GitHub. Podría no ser estable, así que procede con precaución.

pip3 install git+https://github.com/ehForwarderBot/ehforwarderbot.git

Alternative installation methods

You can find a list of alternative installation methods contributed by the community in the project wiki.

For scripts, containers (e.g. Docker), etc. that may include one or more external modules, please visit the modules repository.

Nota

These alternative installation methods are maintained by the community, please consult their respective author or maintainer for help related to those methods.

A stable internet connection

Since the majority of our channels are using polling for message retrieval, a stable internet connection is necessary for channels to run smoothly. An unstable connection may lead to slow response, or loss of messages.

Crea directorios locales

EFB utiliza un estilo de configuración de usuario *nix descrito en detalle en Directorios. En resumen, si estas utilizando la configuración por defecto, necesitas crear ~/.ehforwarderbot, y proporcionar permisos de lectura y escritura al usuario que esta ejecutando EFB.

Elige, instala y habilita los módulos

Currently, all modules that was submitted to us are recorded in the modules repository. You can choose the channels that fits your need the best.

Las instrucciones acerca de como instalar cada canal están disponibles en su documentación respectiva.

Set up with the configuration wizard

When you have successfully installed the modules of your choices, you can the use the configuration wizard which guides you to enable channels and middlewares, and continue to setup those modules if they also have provided a similar wizard.

You can start the wizard by running the following command in a compatible console or terminal emulator:

efb-wizard

If you want to start the wizard of a module for a profile individually, run:

efb-wizard -p <profile name> -m <module ID>

Set up manually

Alternatively, you can enable those modules manually it by listing its Channel ID in the configuration file. The default path is ~/.ehforwarderbot/profiles/default/config.yaml. Please refer to Directorios if you have configured otherwise.

Nota por favor que a pesar de que puedes tener más de un canal esclavo ejecutándose al mismo tiempo, solo puedes tener un canal maestro en un perfil. Mientras que los middlewares son completamente opcionales.

For example, to enable the following modules:

  • Canal maestro
    • Demo Master (foo.demo_master)

  • Canales esclavos
    • Demo Slave (foo.demo_slave)

    • Dummy Slave (bar.dummy)

  • Middlewares
    • Null Middleware (foo.null)

config.yaml should have the following lines:

master_channel: foo.demo_master
slave_channels:
- foo.demo_slave
- bar.dummy
middlewares:
- foo.null

If you have enabled modules manually, you might also need configure each module manually too. Please consult the documentation of each module for instructions.

Launch EFB

ehforwarderbot

Esto ejecutará EFB directamente en el entorno actual. El Perfiles predeterminado es llamado default. Si quieres ejecutar EFB en un perfil diferente, añade --profile <profile-name> al comando.

Para más opciones de línea de comandos usa la opción --help.

Use EFB in another language

EFB supports translated user interface and prompts. You can set your system language or locale environmental variables (LANGUAGE, LC_ALL, LC_MESSAGES or LANG) to one of our supported languages to switch language.

You can help to translate this project into your languages on our Crowdin page.

Nota

If your are installing from source code, you will not get translations of the user interface without manual compile of message catalogs (.mo) prior to installation.

Lanza EFB como un proceso Daemon

Desde la versión 2, EH Forwarder Bot removió el helper del daemon debido a que es inestable su uso. Recomendamos usar una solución más robusta para el manejo del daemon tales como systemd, upstart o pm2.