How to register users from register

Revision as of 13:59, 5 April 2013

Suppose that you have this scenario: you want to register users from a database using PostgreSQL.

Startup configuration file

The main Yate startup configuration is stored in the file yate.conf.

Please notice that "yate.conf" under Windows has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version.
In other words it has to match the executable file name or the file would not be loaded and default configuration will be applied.

Note: By default in Yate all modules are loaded at startup. By setting parameter modload=no in section [default], you have to enable modules by hand to load them.
This is done in section [modules] using parameter that contains the name of the module point yate (e.g pgsqldb.yate=true for using module pgsqldb).

File "yate.conf" controls the loading of modules in Yate. In your yate.conf these modules should be enabled by hand, only if you set modload=disable:

[default]
modload=disable

[modules]
;Module used to make the connection between Yate and the PostgreSQL database.
pgsqldb.yate=true 
;Module used do authenticate, register, route users in the database.  
register.yate=true

Create database

There are 3 steps to accomplish this task:

1. create your database with tables that you need for your configuration (here is an example of a database schema).
2. put the credentials of the database of the database created in Yate's configuration file: pgsqldb.conf).
3. 'tell' Yate which connection to use when users will be registered. This is done in register.conf file.

Configure database in Yate

Set the name of the database

The module used is register.conf and in section [default] the name of the database connection must be set:

[default]
account=Database_Name

Set the connection information of database

In PostgreSQL configuration file: pgsqldb.conf we have to set the connection data for this database in a section that will have the same name as the account settled in register.conf:

[Database_Name]
host=
database=
user=
password=
  

After "=" you have to write your connection information.

Register users

See an example of database schema to keep the users.

In register.conf in section [general] the user.register must be enabled.

[general]
user.register=yes

[user.register]
query=UPDATE users SET location='${data}',expires=CURRENT_TIMESTAMP + INTERVAL '${expires} s' WHERE username='${username}'

See also

• Regfile
• MySQL