| [vhffs-dev] [852] example configuration file is now fully documented |
[ Thread Index |
Date Index
| More vhffs.org/vhffs-dev Archives
]
Revision: 852
Author: gradator
Date: 2007-08-31 19:04:52 +0000 (Fri, 31 Aug 2007)
Log Message:
-----------
example configuration file is now fully documented
Modified Paths:
--------------
trunk/vhffs-backend/conf/vhffs.conf.dist.in
Modified: trunk/vhffs-backend/conf/vhffs.conf.dist.in
===================================================================
--- trunk/vhffs-backend/conf/vhffs.conf.dist.in 2007-08-31 17:18:59 UTC (rev 851)
+++ trunk/vhffs-backend/conf/vhffs.conf.dist.in 2007-08-31 19:04:52 UTC (rev 852)
@@ -9,46 +9,46 @@
# GLOBAL
################################
<global>
- #This is the name of your hosting service
+ # This is the name of your hosting service
host_name = My Hosting service
- #This is the URL of the website of the hoster,
- #if unset, no link will be added to hoster website
+ # This is the URL of the website of the hoster,
+ # if unset, no link will be added to hoster website
host_website = http://vhffs.org/
- #The directory where you store ALL data
+ # The directory where you store ALL data
datadir = /data
- #Directory which contains templates
+ # Directory which contains templates
templatedir = @TEMPLATESDIR@
- #Directory which contains internationalisation stuff
+ # Directory which contains internationalisation stuff
intldir = @INTLDIR@/
- #The default language
+ # The default language
default_language = en_US
- #Mails sent to hosted people have From: vhffs_master
+ # Mails sent to hosted people have From: vhffs_master
vhffs_master = VHFFS Admin <admin@localhost>
- #Mails sent to hosted people about moderations have From: vhffs_moderator
+ # Mails sent to hosted people about moderations have From: vhffs_moderator
vhffs_moderator = VHFFS Admin <moderator@localhost>
- #Tag inserted in the subject of each sent mail
+ # Tag inserted in the subject of each sent mail
mailtag = [VHFFS]
- #Allow subscribing to the platform
+ # Allow subscribing to the platform
allow_subscribe = yes
- #The mail where alert are sent
+ # The mail where alert are sent
alert_mail = root@localhost
- #Are the requests moderated or not
+ # Are the requests moderated or not
moderation = yes
- #Whether to use vhffsfs or not. vhffsfs allows you to provide a
- #virtual home directory depending on the uid of the running process
- #in order to avoid using of a virtual chroot to provide ftp, sftp, or a shell
+ # Whether to use vhffsfs or not. vhffsfs allows you to provide a
+ # virtual home directory depending on the uid of the running process
+ # in order to avoid using of a virtual chroot to provide ftp, sftp, or a shell
use_vhffsfs = no
</global>
@@ -57,67 +57,68 @@
# PANEL
#################################################
<panel>
- #Is the panel open or not ?
+ # Is the panel open or not ?
open = yes
- #URL of the panel
+ # URL of the panel
url = http://your.panel.url
- #Use the public section of VHFFS
+ # Use the public section of VHFFS
use_public = yes
- #The URL to the public part
+ # The URL to the public part
url_public = http://projects.vhffs.org/
- #Directory which contains themes
+ # Directory which contains themes
themesdir = @PANELDIR@/themes
- #The default theme
+ # The default theme
default_theme = vhffs
# Directory used to store captcha files
# Should be readable and writable by webserver user but not accessible to end users.
captchadir = /tmp
- #Obfuscation technique for emails (none, simple, entities or javascript)
+ # Obfuscation technique for emails (none, simple, entities or javascript)
mail_obfuscation = simple
- #This is the URL display for the "Help" link in the panel
+ # This is the URL display for the "Help" link in the panel
url_help = http://help.hoster
- #Use avatar or not ? If yes, you must create a /data/avatar and change owner/permissions
- #so that the webserver can write into this directory
+ # Use avatar or not ? If yes, you must create a /data/avatar and change owner/permissions
+ # so that the webserver can write into this directory
users_avatars = yes
groups_avatars = yes
- #Print statistics in the main page of VHFFS ?
+ # Print statistics in the main page of VHFFS ?
stats_on_home = yes
- #Use RSS for users and groups ?
+ # Use RSS for users and groups ?
rss_users = yes
rss_groups = yes
</panel>
######
-# BACKEND
+# DATABASE
#################################################
<database>
+ # Driver to use, however only PostgresSQL is supported at the moment
driver = pg
- #Database to use
+ # Database to use
db_name = vhffs
- #Username used to access the database server
+ # Username used to access the database server
db_username = vhffs
- #Password
+ # Password
db_password = vhffs
- #DataBase Server
+ # DataBase Server
db_host = localhost
- #Database port
+ # Database port
db_port = 5432
</database>
@@ -125,27 +126,36 @@
######
# USERS AND GROUPS
################################################
-#the default configuration for users
+
+# Configuration for users
<users>
+ # This is a file which contain all refused users, one name per line
+ # fill it with the content of your /etc/passwd
bad_username_file = @CONFDIR@/bl_username
+ # Default quota for users (home directory)
default_quota = 10
+ # Shell configuration, use /bin/false in both to disable any shell account
available_shells = /bin/bash /bin/tcsh /bin/zsh /bin/false
default_shell = /bin/false
- #Notation is useful to handle aggressive users
- #If a project is refused by moderation, the note os the user if decreased
- #If a project or service is accepted, the note is increased
+ # Notation is useful to handle aggressive users
+ # When a request of this user is accepted, the note is increased,
+ # if the request is refused the note is decreased
use_notation = yes
# URL to the documentation (optional)
url_doc = http://help.myhoster.net/user
</users>
+# Configuration for groups
<groups>
+ # This is a file which contain all refused groups, one name per line
+ # fill it with the content of your /etc/group content
bad_groupname_file = @CONFDIR@/bl_groupname
+ # Default quota for groups
default_quota = 100
# URL to the documentation (optional)
@@ -158,8 +168,9 @@
#####################################
<services>
+ # Configuration for web service
<web>
- #use this module or not
+ # Use this module or not
activate = yes
#default domain of website
@@ -204,13 +215,17 @@
url_stats = http://stats.hoster
</web>
+ # Configuration for mysql
<mysql>
- #use this module or not
+ # Use this module or not
activate = yes
+ # Parameters used to connect to MySQL server as admin
host = localhost
username = root
password = mysecret
+
+ # Complete path to mysqldump binary
mysqldump_path = /usr/bin/mysqldump
# URL to phpmyadmin
@@ -220,13 +235,17 @@
url_doc = http://help.myhoster.net/mysql
</mysql>
+ # Configuration for pgsql
<pgsql>
- #use this module or not
+ # Use this module or not
activate = no
+ # Parameters used to connect to PostgresSQL server as admin
host = localhost
username = vhffs
password = mysecret
+
+ # Complete path to the pgdump binary
pgdump_path = /usr/bin/pg_dump
# URL to phppgadmin
@@ -236,12 +255,12 @@
url_doc = http://help.myhoster.net/pgsql
</pgsql>
- #DNS configuration
+ # DNS configuration
<dns>
- #use this module or not
+ # Use this module or not
activate = no
- # default configuration for new domains and new entries
+ # Default configuration for new domains and new entries
default_ns1 = ns1.hoster.org
default_ns2 = ns2.hoster.org
default_mx1 = mx1.hoster.org
@@ -257,7 +276,7 @@
default_serial = 1
default_mbox = adm.your.hoster.ext.
- # initial configuration of each domain name
+ # Initial configuration of new domain name
<init>
<a>
www = 80.0.0.1
@@ -277,30 +296,38 @@
url_doc = http://help.myhoster.net/dns
</dns>
+ # Configuration for cvs
<cvs>
- #use this module or not
+ # Use this module or not
activate = no
+ # URL of the cvsweb
+ # the url scheme is svnweb_url/cvs_$group_$svnname/ , change the code or modify the software used
cvsweb_url = "http://cvsweb.hoster";
# URL to the documentation (optional)
url_doc = http://help.myhoster.net/cvs
</cvs>
+ # Configuration for svn
<svn>
- #use this module or not
+ # Use this module or not
activate = no
+ # URL to the svnweb
+ # the url scheme is svnweb_url/svn_$group_$svnname/ , change the code or modify the software used
svnweb_url = "http://svnweb.hoster";
# URL to the documentation (optional)
url_doc = http://help.myhoster.net/svn
</svn>
+ # Configuration for mail service
<mail>
- #use this module or not
+ # Use this module or not
activate = no
+ # Add checkboxs for spam filter and anti-virus
use_nospam = yes
use_novirus = yes
@@ -308,50 +335,57 @@
url_doc = http://help.myhoster.net/mail
</mail>
- #The mailuser service allows a user to get a mail account on a default domain
- #The domain MUST exists on VHFFS, and should be owned by the user given in this configuration
- # groupneeded : the user cannot create his mail account if it doesn't have at least one group
+ # The mailuser service allows a user to get a mail account on a default domain
<mailuser>
- #use this module or not
+ # Use this module or not
activate = no
+ # The used domain, mails will be $user@domain, it MUST exist in vhffs database
domain = users.myhost.org
+
+ # If set to yes, the user must be in at least one group to create his mail account
groupneeded = yes
# URL to the documentation (optional)
url_doc = http://help.myhoster.net/mailuser
</mailuser>
- #The mailgroup service allows a group to get a mail account on a default domain
- #The domain MUST exists on VHFFS, and should be owned by the user given in this configuration
+ # The mailgroup service allows a group to get a mail account on a default domain
<mailgroup>
- #use this module or not
+ # Use this module or not
activate = no
+ # The used domain, mails will be $group@domain, it MUST exist in vhffs database
domain = projects.myhost.org
# URL to the documentation (optional)
- url_doc = http://help.myhoster.net/mailgroup
+ url_doc = http://help.myhoster.net/mailgroup
</mailgroup>
+ # Configuration for mailing lists
<mailinglist>
- #use this module or not
+ # Use this module or not
activate = no
+ # Default domain is always available, it may be used by users without mail domain
default_domain = lists.vhffs.org
+ # URL to public archives
url_archives = http://localhost/listengine
# URL to the documentation (optional)
url_doc = http://help.myhoster.net/ml
</mailinglist>
- #Configuration of download repository
+ # Configuration of download repositories
<repository>
- #use this module or not
+ # Use this module or not
activate = no
+ # URL to the repositories server
repository_url = "http://download.vhffs.org/";
+
+ # The initial quota of repositories
default_quota = 1024
# Where to find log from webserver, each webserver should be in a separate directory, example :
@@ -399,17 +433,17 @@
# LISTENGINE
#################################
<listengine>
- #The domain is used when listengine bounces mails to SMTP server
- #Listengine will send HELO domain to the SMTP sever
- domain = "myhost.tld"
-
- #Where we store listengine data
+ # Where we store listengine data
datadir = "/data/listengine"
- #Email of listmaster
+ # Email of listmaster
listmaster = "listmaster@xxxxxxxxxx"
- #SMTP Server to bounce listengine mails
+ # The domain is used when listengine bounces mails to SMTP server
+ # Listengine will send HELO domain to the SMTP sever
+ domain = "myhost.tld"
+
+ # SMTP Server to bounce listengine mails
smtp_server = "localhost"
</listengine>
@@ -418,14 +452,12 @@
# ROBOTS
#################################
<robots>
- #Robots should log or not ?
+ # Robots should log or not ?
use_logging = yes
-
- #Logfile to log events
logfile = /var/log/vhffs.log
- #Robots should use lock file ?
- #If they do, only one robot can be executed in the same-time
+ # Robots should use lock file ?
+ # One lock will be created per robot, you can still run robots simultaneously
use_lock = yes
lockfile = /var/lock/vhffs
</robots>