How to register users from register

From Yate Documentation
(Difference between revisions)
Jump to: navigation, search
(Created page with "Supose we want to register our users from a database and we choose PostgreSQL. After creating our database with the table that we need, we have to tell Yate what database to ...")
 
 
(20 intermediate revisions by one user not shown)
Line 1: Line 1:
−
Supose we want to register our users from a database and we choose PostgreSQL.
+
Suppose that you have this scenario: you want to register users from a database using PostgreSQL.
  
−
After creating our database with the table that we need, we have to tell Yate what database to use. So we write in [[register|register.conf]] the name of the database connection that we use:
+
===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]
 
  [default]
−
  account=Database_Name
+
  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
 +
 
 +
===Configure database in Yate ===
 +
 
 +
There are 3 steps to accomplish this task:
 +
# create your database with tables that you need for your configuration (here is an example of [[Register_Database_Schema|a database schema]]).
 +
# put the credentials of the database of the database created in Yate's configuration file: pgsqldb.conf).
 +
# 'tell' Yate which connection to use when users will be registered. This is done in register.conf file.
 +
 
 +
 
 +
==== Set the connection information of database====
 +
 
 +
In PostgreSQL configuration file: [[PostgreSQL|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:
 +
 
 +
[yateadmin]
 +
host=localhost
 +
port=5432
 +
database=yateadmin
 +
user=postgres
 +
password=secret
 +
 
 +
After "=" you have to write your connection information.
 +
 
 +
==== Set the name of the database====
 +
 
 +
In module used is [[register|register.conf]], in section [default] the name of the database must be set:
 +
 
 +
[default]
 +
account=yateadmin
 +
 
 +
===Register users ===
 +
 
 +
See an example of a [[Register_Database_Schema|database schema]] to keep the users data.
 +
 
 +
In [[Register|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'''
  
−
And 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:
+
* [[Regfile|Regfile module]] - authenticate, register and route users from a file.
 +
* [[Register|Register module]] - authenticate, register and route users from database.
 +
* [[PostgreSQL]]
 +
* [[Routing]]
  
−
[Database_Name]
+
[[Category:Registration]] [[Category:Database]] [[Category:Users]]
−
host=
+
−
database=
+
−
user=
+
−
password=
+

Latest revision as of 15:59, 31 October 2013

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

Contents

[edit] 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

[edit] Configure database in Yate

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.


[edit] 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: 

[yateadmin]
host=localhost
port=5432
database=yateadmin
user=postgres
password=secret

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

[edit] Set the name of the database

In module used is register.conf, in section [default] the name of the database must be set: 

[default]
account=yateadmin

[edit] Register users

See an example of a database schema to keep the users data.

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

Retrieved from "https://docs.yate.ro/wiki/index.php?title=How_to_register_users_from_register&oldid=7224"
Personal tools
Namespaces

Variants
Actions
Preface
Configuration
Administrators
Developers