CFVERSD.CONF

DESCRIPTION

This manual page documents the /etc/cfvers/cfversd.conf configuration file for the cfvers system version 0.5.4.

cfvers is a version control system designed for the management of configuration files in Unix-like operating systems..

cfversd.conf is the configuration file for the server cfversd.

The filename structure is that of an .ini file (it's parsed by Python's ConfigParser module):

[section1]
key1=value1
key2=value2
[section2]

Available sections

The available sections are server, repository, auth and the per-user user-NAME, where NAME is the user's name.

server section

The port key selects the port number to listen on.

The pidfile key selects the filename into which to write the pid of the server.

repository section

The method key selects the driver for the repository. Currently defined are postgresql and sqlite.

The connect key selects the driver-specific connection string. For example, for sqlite it is the filename into which to store the database.

auth section

The users key is the only one valid and it contains a comma separated list of valid users. For each user, a separate user-NAME section must exist, with NAME being the user's name in this list.

user-NAME section

The user-NAME sections each define a valid user togheter with its rights.

The valid_from option contains the comma separated list of valid IP addresses. The list must contain only host ip addresses, without netmasks.

The areas option contains the comma separated list of valid areas for this user, if the user hasn't the admin flag true.

The admin boolean option specifies if this user is a regular user or an admin user. Only an admin user can create areas, and the admin users can access all areas.

The client_password and server_password key contain the client-to-server and server-to-client password. They can be the same thing or not.

Postgresql driver

For postgresql, the connect information to the database, is in the following format: dbname=mydb user=myuser password=mypassword. The available keys/value pairs are:

dbname: the name of the database to connect to (required);
user: the username to use when connecting to the database; not required (in which case the connection will use your login name);
password: the password for the database; not required if you use the trust authentication method;
host: the IP address or name of the database server; if not given, the connection will be on localhost through UNIX sockets;

For more options possible, please consult the Postgresql documentation.

Sqlite driver

For sqlite, the connection data is simply a string containing a filename. In it the database will be written.

EXAMPLES

server with sqlite

[server]
port = 9999
pidfile = /var/run/cfvers/cfversd.pid

[repository]
method=sqlite
connect=/var/lib/cfvers/database

[auth]
users=user1

[user_user1]
client_password=cpw
server_password=spw
valid_from=127.0.0.1,192.168.0.2
areas=default
admin=true

server with postgresql

[server]
port = 9999
pidfile = /var/run/cfvers/cfversd.pid

[repository]
method=postgresql
connect=dbname=mydb user=myuser password=mypass

[auth]
users=user1

[user_user1]
client_password=cpw
server_password=spw
valid_from=127.0.0.1,192.168.0.2
areas=default
admin=true

AUTHOR

This manual page was written by Iustin Pop <iusty@k1024.org>

The manual pages cvs(1) and svn(1) were used as sources of inspiration (and copy-paste in some cases), since these are real versioning programs :-), with proper man pages.