4 @FORGENAME@ is packaged for Debian, and was formerly packaged under
5 the 'gforge' source package name. Even though a transition is in
6 progress towards renaming it widely, only high-level meta-packages are
7 named with the '@PACKAGE@' prefix. The rest of the packages are
8 still named with the 'gforge-' prefix, so expect most paths and
9 filenames to still be named in relation to 'gforge'.
13 Want to know what the status of this package is? Read
14 /usr/share/doc/@PACKAGE@/TODO.Debian or (even better)
15 <https://fusionforge.org/plugins/mediawiki/wiki/fusionforge/index.php/Roadmap>. If you miss a
16 feature, or find a bug, or want to help, don't hesitate to contact me
17 (Roland Mas <lolando@debian.org>) . Plenty of features are missing,
18 I'm working on some, but if you don't tell me which ones you miss the
19 most I might process them in the wrong order for you.
21 Please read the bug reports on the Debian bug-tracking system (at
22 <URL:http://bugs.debian.org/cgi-bin/pkgreport.cgi?pkg=@PACKAGE@>)
23 before submitting new ones. Be warned that bug reports describing a
24 problem precisely and/or offering a solution will probably be
30 See contents of /usr/share/doc/@OLDPACKAGE@-common/ first.
32 Although a few documentation files from upstream are included, they
33 are either very out of date or practically useless. I mostly include
34 them for completeness's sake (and per request, too). The files I'm
35 referring to are Install_Guide.html, Adminstration_Guide.html,
36 Contributor_Guide.html, INSTALL, and AUTHORS.
41 @FORGENAME@ is a big piece of software. It's far-reaching. It
42 fiddles with many different parts of the system. As automated as I
43 have tried to make its installation, there are still things that need
44 to be done by hand, maybe even by a system administrator.
46 First, you'll need a hostname. Get the @PACKAGE@.<your-domain>
47 DNS name to be created, pointing on the IP address of the host you're
48 installing @FORGENAME@ on. The "@PACKAGE@" part isn't required, you
49 can call it however you like. However, I'll assume you chose
50 "@PACKAGE@" from now on; substitute as needed.
52 If you want to use the Apache virtual hosting service, you'll even
53 need a delegation of a subdomain. Get your system administrator to
54 delegate you the SOA for the @PACKAGE@.<your-domain> subdomain.
55 This will allow @FORGENAME@ to create new hostnames for projects when
56 needed (foo.@PACKAGE@.<your-domain>, for instance), as well as some
57 hostnames needed by the system (for mailing-lists or SCM, for
60 The LDAP server is hosted on the same host and automatically
61 managed, therefore you should not have to worry too much about it.
62 You might be able to access it from another host, but I'm not sure
63 you'll be able to modify the entries in it. I would advise not to in
64 any case, since it would make the data contained in the LDAP directory
65 inconsistent with the real data stored in the PostgreSQL database.
67 You'll need a configured MTA for @FORGENAME@. Depending on whether
68 the @FORGENAME@ users are local or remote, you might need to set up a
69 smarthost or something else. @FORGENAME@ depends on a working mail
70 system, and you won't be able to create user accounts without it. I'm
71 not sure yet what advanced tricks need to be done with the MTA. There
72 might be some stuff to do with virtual domains for mailing-lists or
73 user email forwarding... I haven't fully investigated it yet. Your
74 contribution will be most welcome.
76 Depending on the targeted audience, you might want to get a real
77 SSL/TLS certificate from some certification authority, whether it be a
78 professional one or your personal one (or the one in your company).
79 Otherwise, just use mod-ssl-makecert as advised during the
80 configuration phase, and get your own custom certificate.
82 Do *not* delete the /etc/@PACKAGE@/*.template files. They are
83 needed. Do not alter them either unless you *know* what you're doing.
86 Custom local configuration
87 --------------------------
88 With default Debian settings, a set of conf files have been generated,
89 and will contain the desired settings for runtime :
90 - /etc/gforge/local.inc
91 - ... (TO BE DOCUMENTED PROPERLY !)
93 Should these settings not suit you, it is possible to change
94 configuration options by :
96 1. modifying /etc/@PACKAGE@/@PACKAGE@.conf which contains the
98 ( 2. Optional : copy some template files from
99 /usr/share/gforge/etc/local.d/ to /etc/gforge/local.d/ (TO BE
100 DOCUMENTED PROPERLY !) )
101 3. regenerate the runtime config files by issueing :
104 Customizations in /etc/@PACKAGE@/@PACKAGE@.conf may include :
105 - switching to HTTPS with 'sys_use_ssl=true',
106 - setting a custom URL prefix with 'sys_urlprefix=/@PACKAGE@/' for
113 Once @FORGENAME@ is setup, it pretty much runs by itself. There
114 should be relatively few things to do for the administrator. The
115 following are random notes trying to document them.
117 You'll need to periodically check the Approve Pending Projects page
118 as well as the Approve News Bytes one, and take appropriate action.
119 That can be done by the `admin' user (or any user having admin
120 permissions on the `siteadmin' project) via the web interface.
122 If you need to add skills to the database after installation, you
123 can use the sf-add-skill script. Give it a skill (or a list of
124 skills) and it'll insert it into the databse. This script is located
125 in /usr/share/@PACKAGE@/bin/.
127 For cvs to work you have to add a symlink doing
128 ln -s /var/lib/@PACKAGE@/chroot/cvsroot /cvsroot.
129 We can't do this for Debian policy reason that forbid this.
131 ln -s /var/lib/@PACKAGE@/chroot/svnroot /svnroot is to be done
133 Don't forget about adding
134 SYSLOGD="-p /dev/log -a /var/lib/@PACKAGE@/chroot/dev/log" in /etc/default/syslog
135 This is a WARNING you might have seen at install, essential if you run
136 anonymous cvs in a root jail (This is the default in Debian)
138 If you would like to add a theme to your @FORGENAME@, you'll first
139 have to compose it. Please refer to README.Themes.
141 Other customisations are described in README.Custom.
146 Apart from the SourceForge crew at VA Linux, who did (and probably
147 still do) a great job with SF, I'd like to send my thanks to Guillaume
148 Morin, who wrote a very thorough SourceForge installation guide. That
149 guide gives step-by-step instructions for the installation procedure,
150 and a big part of the packaging task was to turn these instructions
151 into automated scripts. Even if this package has evolved a lot since
152 then, it was originally based on his guide.
154 Thanks also to all who tested packages and helped correct many
155 errors of mine. In particular, thanks to all who submitted patches.
157 And mega-thanks to Christian Bayle. That guy single-handedly
158 adapted and fixed all the scripts related to SCM, DNS, SSH accounts,
161 -- Roland Mas <lolando@debian.org>, Thu Jul 24 21:33:33 2003