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>.
16 If you miss a feature, or find a bug, or want to help, don't hesitate
17 to contact me (Roland Mas <lolando@debian.org>) . Plenty of features
18 are missing, I'm working on some, but if you don't tell me which ones
19 you miss the 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.
85 See /usr/share/doc/@PACKAGE@-web-apache2/README.Debian(.gz) for
86 more details about the Apache webserver configuration options for
89 Custom local configuration
90 --------------------------
91 With default Debian settings, a set of conf files have been generated,
92 and will contain the desired settings for runtime :
93 - @CONFIG_PATH@/config.ini
94 - @CONFIG_PATH@/config.ini.d/*.ini
96 They are standard Windows-style *.ini files, and can be updated with
97 any text editor. They should be taken into account immediately by the
98 web part of the forge and any subsequent runs of the cron jobs. Note
99 however that some require manual intervention: for instance, if you
100 change the name of the database, you will need to perform the
101 appropriate steps in the database server too.
103 Instead of changing the contents of the existing file, you may wish to
104 add only your custom local settings which differ from the packaged
105 defaults in a dedicated overriding file, for example in the provided
106 /etc/@PACKAGE@/config.ini.d/zzzz-local.ini. This will make it
107 easier to track local customizations.
112 Once @FORGENAME@ is set up, it pretty much runs by itself. There
113 should be relatively few things to do for the administrator. The
114 following are random notes trying to document them.
116 You'll need to periodically check the Approve Pending Projects page
117 as well as the Approve News Bytes one, and take appropriate action.
118 That can be done by the `admin' user (or any user having admin
119 permissions on the `siteadmin' project) via the web interface.
121 If you need to add skills to the database after installation, you
122 can use the sf-add-skill script. Give it a skill (or a list of
123 skills) and it'll insert it into the databse. This script is located
124 in /usr/share/@PACKAGE@/bin/.
126 For cvs to work you have to add a symlink doing
127 ln -s /var/lib/@PACKAGE@/chroot/cvsroot /cvsroot.
128 We can't do this for Debian policy reason that forbid this.
130 ln -s /var/lib/@PACKAGE@/chroot/svnroot /svnroot is to be done
132 Don't forget about adding
133 SYSLOGD="-p /dev/log -a /var/lib/@PACKAGE@/chroot/dev/log" in /etc/default/syslog
134 This is a WARNING you might have seen at install, essential if you run
135 anonymous cvs in a root jail (This is the default in Debian)
137 If you would like to add a theme to your @FORGENAME@, you'll first
138 have to compose it. Please refer to README.Themes.
140 Other customisations are described in README.Custom.
145 Apart from the SourceForge crew at VA Linux, who did (and probably
146 still do) a great job with SF, I'd like to send my thanks to Guillaume
147 Morin, who wrote a very thorough SourceForge installation guide. That
148 guide gives step-by-step instructions for the installation procedure,
149 and a big part of the packaging task was to turn these instructions
150 into automated scripts. Even if this package has evolved a lot since
151 then, it was originally based on his guide.
153 Thanks also to all who tested packages and helped correct many
154 errors of mine. In particular, thanks to all who submitted patches.
156 And mega-thanks to Christian Bayle. That guy single-handedly
157 adapted and fixed all the scripts related to SCM, DNS, SSH accounts,
160 -- Olivier Berger <obergix@debian.org>, Thu, 16 Aug 2012 12:55:46 +0200