FOSSology

h1. Installing FOSSology on Debian

Packages for deb based distributions are available from different sources, depending on release. Consult the appropriate instructions below for the line to add to your /etc/apt/sources.list file.

h2. Debian squeeze (currently stable) 

FOSSology 2.0 debs, produced by the FOSSology team.  These debs have not yet been submitted to debian upstream.  Older versions of FOSSology are available from the debian and ubuntu repositories.  To use the FOSSology produced debs add the line below to your /etc/apt/sources.list file.

  deb http://fossology.org/releases/2.0.0/Debian/squeeze/ 6.0 contrib

Be sure to remove any entries you may have in sources.list for older versions of fossology.  

Clean and update the apt cache with (as root) @apt-get clean; apt-get update@

h2. Single vs. Multi-system installs:

The FOSSology software has been split into separate packages by function and analysis agent in order to make it easy to add, update and install individual agents.  

*For a single system package install*, (as root) type @apt-get install fossology@  This will install all packages needed to run FOSSology on a single system.  You can safely ignore this warning, "WARNING: The following packages cannot be authenticated!"  It is a known bug that will be addressed in the next release. 

After running apt-get install, skip down to step 6 in the next section (cluster install) to configure your system for fossology.

*For a cluster install*, follow these steps (as root):

# Install the FOSSology server... db, web server, agents, etc...

@apt-get install fossology@

# Install the "agent" systems where the analysis agents will run.

@apt-get install fossology-common fossology-buckets fossology-copyright fossology-delagent fossology-mimetype fossology-nomos fossology-pkgagent fossology-ununpack fossology-wgetagent@

# edit fossology.conf & Db.conf on the server and copy to the agents

+Db.conf+

<pre>

dbname=fossology;

host=<server_hostname>;

user=fossy;

password=fossy;

</pre>

+fossology.conf+

<pre>

; proxy settings that will be used by fossology agents

; examples:

;http_proxy = http://server:8080

;ftp_proxy = http://server:3128

;no_proxy = localhost,10.1.2.3

</pre>

<pre>

[HOSTS]

localhost = localhost /etc/fossology  10

<agent1_hostname>= <agent1_hostname> /etc/fossology  10

<agent2_hostname>= <agent2_hostname> /etc/fossology  10

</pre>

<pre>

[REPOSITORY]

<server_hostname>[] = * 00 55

<agent1_hostname>[] = * 56 aa

<agent2_hostname>[] = * ab ff

</pre>

+Don't forget to copy these conf files to each of your agents!+

# Make your repository available to the entire cluster.  This is highly dependent on your storage and filesystem type.  These instructions are for a distributed, nfs cross-mounted repository as per the [REPOSITORY] section of the fossology.conf file above.

a) Cross-mount filesystems for your repository data on all systems (in this case, the 3 systems are _server, agent1 & agent2_) and create a link called localhost pointing to the host where it's created:

<pre>

root@server# ls -al

total 20

drwxrwx--- 5 fossy fossy 4096 Apr 12 15:58 .

drwxrwx--- 3 fossy fossy 4096 Apr 10 15:12 ..

drwxrws--- 3 fossy fossy 4096 Apr 10 13:27 agent1

drwxrws--- 3 fossy fossy 4096 Apr 10 05:40 agent2

lrwxrwxrwx 1 root  root     5 Apr 12 15:58 localhost -> server

drwxrws--- 2 fossy fossy 4096 Apr 10 14:32 server

</pre>

<pre>

root@agent1# ls -al

total 20

drwxrwx--- 5 fossy fossy 4096 Apr 12 15:58 .

drwxrwx--- 3 fossy fossy 4096 Apr 10 15:12 ..

drwxrws--- 3 fossy fossy 4096 Apr 10 13:27 agent1

drwxrws--- 3 fossy fossy 4096 Apr 10 05:40 agent2

lrwxrwxrwx 1 root  root     5 Apr 12 15:58 localhost -> agent1

drwxrws--- 2 fossy fossy 4096 Apr 10 14:32 server

</pre>

<pre>

root@agent2# ls -al

total 20

drwxrwx--- 5 fossy fossy 4096 Apr 12 15:58 .

drwxrwx--- 3 fossy fossy 4096 Apr 10 15:12 ..

drwxrws--- 3 fossy fossy 4096 Apr 10 13:27 agent1

drwxrws--- 3 fossy fossy 4096 Apr 10 05:40 agent2

lrwxrwxrwx 1 root  root     5 Apr 12 15:58 localhost -> agent2

drwxrws--- 2 fossy fossy 4096 Apr 10 14:32 server

</pre>

Make sure your user:group is fossy:fossy and permission are 2770 on all systems in your cluster.

b) Create repository sub-directories on all systems in the cluster and set permissions to 2770 (setgid bit on): 

<pre>

cd localhost

mkdir files gold logs ununpack wget

chown -R fossy:fossy *

chmod 2770 *

</pre>

# Create & test ssh keys for user fossy

a) Create SSH keys for the fossy user and distribute them on all hosts. The keys should NOT include a pass-phrase. (Since the scheduler cannot enter a password, a require pass-phrase will cause the remote execution to fail.) 

b) Test the keys (including accepting the server key for the first connection). You should be able to login without a password.

# Additional _*REQUIRED*_ configuration

Full instructions are available in the source install file "FOSSology version 2.0 INSTALL file":http://fossology.svn.sourceforge.net/viewvc/fossology/branches/fossology2.0/fossology/install/INSTALL.

To summarize, the following must be configured:

  * kernel parameters

 To set on a running system:

<pre>

# echo 512000000 > /proc/sys/kernel/shmmax

</pre>

 To make sure it gets set on boot

<pre>

# echo "kernel.shmmax=512000000" >> /etc/sysctl.conf

</pre>

  * Adjust postgresql configuration

  * Adjust PHP config (both apache and cli)

  * Adjust apache2 configuation (sites-available)

See the above INSTALL file for details.