2 This directory provides support for generating the local.inc file
3 automatically with no editing of the resultant file in almost all
7 For those not wanting to read any further, you can try it out by
9 ./configure --with-domain-name=`hostname | cut -d. -f 2,3` --with-sys-upload-dir=/tmp
11 ( the upload directory needs to exist, be writeable and not be
12 inside the www directory, /tmp is probably not what you want :-)
15 You can compare the output file to that not using autoconf using :-
17 diff -u ../../etc/local.inc local.inc
19 In addition to generating a local.inc, this also generates a file
20 containing sample Apache vhost directives.
24 ********************************************************************
26 No files will be installed, it is the responsibility of the
27 administrator/packager to copy the output files into their
30 ********************************************************************
37 The configuration support is currently in "contrib" because it does
38 not yet provide enough features for those wanting to build pacakges
39 to make it worthwhile them switching. In particular those using Debian
40 should continue to use the Debian build/configuration tools, since they
41 have more features and are integrated into the OS.
43 However, if you are curerntly using CVS or installing GForge
44 yourself, then this should prove helpful, if not I'd like to know
45 what you want changed.
48 GFORGE Configuration HOWTO.
49 ===========================
51 The support for configuration of GForge is new and has not been
52 fully tested on all possible configurations. The files that it uses
53 for inputs and outputs are in this direcotry, so using ./configure
54 will not damage the settings of an existing system.
57 The current configuration implementation has been designed to be
58 both flexible and easy to use. You can list the full set of
59 configrable options by typing :-
63 At the time of writing this document, the full list of options are :-
66 --disable-FEATURE do not include FEATURE (same as --enable-FEATURE=no)
67 --enable-FEATURE[=ARG] include FEATURE [ARG=yes]
68 --enable-defaults=TYPE enable TYPE specific defaults (None)
69 --enable-ldap enable LDAP (no)
70 --enable-jabber enable Jabber (no)
73 --with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
74 --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
75 --with-domain-name the default domain (company.com)
76 --with-sys-default-domain
77 the gforge server (gforge.DOMAIN-NAME)
78 --with-sys-fallback-domain
79 the gforge fallback server (gforge2.DOMAIN-NAME)
80 --with-sys-internal-network
81 netmask of internal network (192.168.1.)
82 --with-sys-cvs-host the CVS server (cvs.DOMAIN-NAME)
83 --with-project-cvs-hosts
84 run an individual CVS server per project (a single
85 CVS server for the entire site)
86 --with-sys-download-host
87 the download server (download.DOMAIN-NAME)
88 --with-sys-upload-host the upload server (upload.DOMAIN-NAME)
89 --with-sys-shell-host the shell server (shell.DOMAIN-NAME)
90 --with-sys-users-host the users server (users.DOMAIN-NAME)
91 --with-sys-docs-host the docs server (docs.DOMAIN-NAME)
92 --with-sys-lists-host the lists server (lists.DOMAIN-NAME)
93 --with-sys-dns1-host the primary nameserver (ns1.DOMAIN-NAME)
94 --with-sys-dns2-host the secondary nameserver (ns2.DOMAIN-NAME)
95 --with-sys-dbhost the DB server (localhost)
96 --with-sys-dbreadhost the readonly DB server (localhost)
97 --with-sys-dbreaddb databases that are read only (stats)
98 --with-sys-dbname name of database (alexandria)
99 --with-sys-dbuser user to access DB as (www)
100 --with-sys-dbpasswd use password to access DB
101 --with-sys-ldap-host LDAP server (ldap.DOMAIN-NAME)
102 --with-sys-ldap-base-dn LDAP base dn (dc=DOMAIN-NAME)
103 --with-sys-ldap-bind-dn LDAP bind dn (cn=SF_robot,$LDAP_BASE_DN)
104 --with-sys-ldap-admin-dn
105 LDAP admin dn ($LDAP_ADMIN_DN)
106 --with-sys-ldap-password
108 --with-sys-jabber-host Jabber server (jabber.DOMAIN-NAME)
109 --with-sys-jabber-user Jabber messages come from USER (noreply)
110 --with-sys-jabber-pass JABBER password (temp123)
111 --with-sys-path-to-jpgraph
113 --with-sys-upload-dir location of upload, must be outside of DocumentRoot
114 --with-homedir-prefix homedir prefix ($HOME_DIR)
115 --with-groupdir-prefix groups prefix ($GROUP_DIR)
116 --with-cgi-dir directory for CGIs
117 --with-ftpincoming-dir directory for a users incoming files
118 --with-db=DB DB to use (only pgsql currently supported)
119 --with-scm=SCM SCM system to use (only CVS currently supported)
120 --with-sys-name the name of the GForge installation (prodigy)
121 --with-sys-news-group the group id for news (3)
122 --with-sys-stats-group the group id for stats (2)
123 --with-sys-peer-rating-group
124 the group id for peer ratings (4)
125 --with-default-trove-cat
126 the default Trove category (18)
127 --with-sys-theme Theme to use by default (gforge)
128 --with-sys-lang language to use (English)
129 --with-sys-session-key the session key (generate one using ps)
132 As a first pass, you will want to set the default domain
133 (--with-domain-name) and the uploads directory (--with-sys-upload-dir).
135 Since the number of options is quite large, a facility has been
136 provided to provide configurable defaults (--enable-defaults=TYPE).
137 TYPE can be a built-in set of defaults (there is an early attempt
138 at generating Debian specific defaults, although these would probably
139 be useful for any FHS compliant system), or it can be an absolute
140 pathname to a file in Bourne shell syntax that will be sourced and
141 used to provide the defaults, for example :-
143 ./configure --enable-defaults=`pwd`/mysite.config
145 And ./mysite.config could contain
147 domain_name=mysite.com
149 Obviously for a single line this isn't worth it, but if you find
150 yourself having to pass lots of options to configure gforge exactly as
151 you want, you may want to use a defaults file.
153 If you are a Linux distribution or OS vendor, I will take changes to add
154 your defaults to the set of built-ins.
160 There is an intention to adapt the infrastructure to support user
161 contributed patches and plugins that require configuration before
164 There has been some discussion on this, but it is still a
165 work-on-the-back-of-an-envelop.