Weboob » Documentation »

Backends Configuration

Abstract

Weboob provides several backends. A backend can be used without configuration parameters, but when the underlaying website requires an authentification, for example, you'll have to enter your login/password. In this case, you need to configure backends.

To configure backends, you can edit the file $HOME/.config/weboob/backends, or use the weboob-config command, or use the GUI weboob-config-qt. Every application share this backends list.

A backend can be configured one or several times. Each configured backend must have an instance name. For example, if you have two accounts on http://www.linuxfr.org, you can add two instances of the backend "dlfp", named "dlfp1" and "dlfp2".

Edit configuration file

You can edit $HOME/.config/weboob/backends and add several blocks in form:

[name]
_backend = backend_name
#_proxy = http://proxy:8080
parameter1 = value1
parameter2 = value2
...
  • name is the name of the backend instance;
  • _backend is the backend name;
  • _proxy is an optional parameter to use a proxy with this backend;
  • you can add optional backend parameters.

For example:

[dlfp1]
_backend = dlfp
username = moules
password = blabla

weboob-config

This tool can be used to simplifier the backends management

Show available backends

$ weboob-config backends

Show information about a backend

$ weboob-config info BACKEND

For example:

$ weboob-config info dlfp
.------------------------------------------------------------------------------.
| Backend dlfp                                                                 |
+-----------------.------------------------------------------------------------'
| Version         | 0.4
| Maintainer      | Romain Bignon <romain@weboob.org>
| License         | GPLv3
| Description     | Da Linux French Page
| Capabilities    | CapMessages, CapMessagesPost, CapUpdatable
|                 |
| Configuration   | username: Username on website
|                 | password: Password of account
|                 | get_telegrams: Get telegrams (default: False)
|                 | get_news: Get newspapers (default: True)
'-----------------'

Add a backend

You can instance a backend with:

$ weboob-config add BACKEND [PARAMETERS]

For example:

$ weboob-config add dlfp
Configuration of backend
------------------------
[username] Username: moules
[password] Password (hidden input):
[get_news] Get newspapers (Y/n):
[get_telegrams] Get telegrams (y/N): y
------------------------
Backend "dlfp" successfully added.

You can also specify parameters on command-line to prevent the interactive questions.

Show configured backends

$ weboob-config list
  Instance       Name           Params
+--------------+--------------+------------------------------------------------+
  bnporc         bnporc         login=6531236523, password=******
  dlfp_moules    dlfp           username=moules, password=******, get_telegrams=1, get_news=0

Remove a configured backend

$ weboob-config remove BACKEND_INSTANCE

For example:

$ weboob-config remove dlfp_moules

Register a new account

Some backends support the CapAccount capability and allow you to register a new account on their supported website. You can use weboob-config to create a new account:

$ weboob-config register BACKEND

Then, it asks you questions about the account to create, and finally propose you to create a backend instance of this new account.

weboob-config-qt

This is a graphical Qt application to edit the backends configuration.

Just run it with:

$ weboob-config-qt

qweboobcfg.png (76.8 KB) Romain Bignon, 08/4/2010 04:31 pm

Also available in: HTML TXT