Tree [972204] rc/add-search-directory /
History



File Date Author Commit
Allura 2012-08-13 Rick Copeland Rick Copeland [972204] Some tweaks to search results
AlluraTesting 2011-10-13 Dave Brondsema Dave Brondsema [3eae9b] [#2936] more test fixes
ForgeBlog 2012-03-21 Ben Gaisne Ben Gaisne [c83adb] A bunch of styling changes
ForgeChat 2011-05-16 Rick Copeland Rick Copeland [d8d2ba] [#2020] Update Allura to use the new Ming decla...
ForgeDiscussion 2012-03-21 Ben Gaisne Ben Gaisne [c83adb] A bunch of styling changes
ForgeDownloads 2012-01-26 Jonathan T. Beard Jonathan T. Beard [e979b0] Remove reference to p4foss and set to new defau...
ForgeGit 2012-07-25 Patrick McGarry Patrick McGarry [c5f674] Added p4 back as an option for create_new_proje...
ForgeHg 2012-07-25 Patrick McGarry Patrick McGarry [c5f674] Added p4 back as an option for create_new_proje...
ForgeLink 2011-06-24 Jenny Steele Jenny Steele [65a86e] [#2117] Removed flyway migrations and organized...
ForgeP4 2012-08-08 Rick Copeland Rick Copeland [db269a] [#173] Create refresh triggers will fully-quali...
ForgeSDP 2012-07-11 vagrant vagrant [826314] Add new ldap-auth command for p4 triggering
ForgeSVN 2012-07-25 Patrick McGarry Patrick McGarry [c5f674] Added p4 back as an option for create_new_proje...
ForgeTracker 2012-08-10 Patrick McGarry Patrick McGarry [fa53b8] Fixed nginx file size limit, adding messages to...
ForgeWiki 2012-03-21 Ben Gaisne Ben Gaisne [c83adb] A bunch of styling changes
NoWarnings 2011-02-01 Wolf Wolf [b70db4] License is Apache 2
conf.d 2012-03-30 Rick Copeland Rick Copeland [56386b] fix supervisor conf
etc 2012-08-08 Rick Copeland Rick Copeland [cd0e09] Beginning work on sitewide directory
schroot 2012-07-30 Rick Copeland Rick Copeland [599956] Make sure the schroot is stopped after getting ...
scripts 2012-03-23 Scuttlemonkey Scuttlemonkey [9fdb2b] adding mercurial to trove
solr_config 2012-08-09 Rick Copeland Rick Copeland [a550f7] Add logic to restrict search to only results re...
.gitattributes 2011-03-13 Wolf Wolf [5a27ea] make git-diff hunk headers python-aware
.gitignore 2012-07-09 Rick Copeland Rick Copeland [2f078b] Minor fixes
.gitmodules 2009-12-01 Wolf Wolf [e5be1c] Remove Ming submodule
CONTRIBUTING 2011-02-08 Wolf Wolf [fd9584] point CONTRIBUTING at the public support bug tr...
LICENSE 2011-02-01 Wolf Wolf [b70db4] License is Apache 2
README.markdown 2012-07-09 Rick Copeland Rick Copeland [2f078b] Minor fixes
coverage-report-all.sh 2011-01-27 Paul Sokolovsky Paul Sokolovsky [6022e7] [#1237] Add script to produce combined coverage...
rebuild.bash 2011-03-30 Paul Sokolovsky Paul Sokolovsky [7c8bda] Remove reference to no longer existing pyforge ...
requirements-common.txt 2012-07-10 Rick Copeland Rick Copeland [5819c5] Working on integrating SDP stuff
requirements-dev.txt 2011-10-06 Rick Copeland Rick Copeland [60d59c] [#2936] working on getting environment more sane
requirements.txt 2012-07-09 Rick Copeland Rick Copeland [2f078b] Minor fixes
run_tests 2011-04-28 Dave Brondsema Dave Brondsema [581a4a] remove unused solr bootstrap from run_tests
schema.xml 2010-02-12 Jonathan T. Beard Jonathan T. Beard [f86850] FORGE-305: More fixes for solr broken config

Read Me

Sandbox Creation

We'll use VirtualBox and
Ubuntu 11.10 to create a disposable sandbox for Forge
development/testing.

  • Download and install VirtualBox for
    your platform.
  • Download a minimal
    Ubuntu 11.10 64-bit ISO.
  • Create a new virtual machine in Virtual Box, selecting Ubuntu (64 bit) as the
    OS type. The rest of the wizards' defaults are fine.
  • When you launch the virtual machine for the first time, you will be prompted to
    attach your installation media. Browse to the mini.iso that you downloaded
    earlier.
  • After a text-only installation, you may end up with a blank screen and blinking
    cursor. Press Alt-F1 to switch to the first console.
  • Consult available documentation for help installing Ubuntu.

Forge Installation

Before we begin, you'll need the following additional packages in order to work
with the Forge source code.

~$ sudo aptitude install git-core subversion python-svn libtidy-0.99-0

You'll also need additional development packages in order to compile some of the
modules.
Use google for additional PIL/jpeg help.

~$ sudo aptitude install default-jdk python-dev libssl-dev libldap2-dev libsasl2-dev libjpeg8-dev zlib1g-dev
~$ sudo ln -s /usr/lib/x86_64-linux-gnu/libz.so /usr/lib

And finally our document-oriented database, MongoDB::

~$ sudo aptitude install mongodb-server

Setting up a virtual python environment

The first step to installing the Forge platform is installing a virtual
environment via virtualenv. This helps keep our distribution python
installation clean.

~$ sudo aptitude install python-pip
~$ sudo pip install -U virtualenv

Once you have virtualenv installed, you need to create a virtual environment.
We'll call our Forge environment 'anvil'.

~$ virtualenv anvil

This gives us a nice, clean environment into which we can install all the forge
dependencies. In order to use the virtual environment, you'll need to activate
it. You'll need to do this whenever you're working on the Forge codebase so you
may want to consider adding it to your ~/.bashrc file.

~$ . anvil/bin/activate

Installing the Forge code and dependencies

Now we can get down to actually getting the Forge code and dependencies
downloaded and ready to go.

(anvil)~$ mkdir src
(anvil)~$ cd src
(anvil)~/src$ git clone git://git.code.sf.net/p/allura/git.git forge

Although the application setup.py files define a number of dependencies, the
requirements.txt files are currently the authoritative source, so we'll use
those with pip to make sure the correct versions are installed.

(anvil)~/src$ cd forge
(anvil)~/src/forge$ pip install -r requirements-dev.txt

And now to setup each of the Forge applications for development. Because there
are quite a few (at last count 15), we'll use a simple shell loop to set them
up.

for APP in Allura* Forge* NoWarnings
do
    pushd $APP
    python setup.py develop
    popd
done

Hopefully everything completed without errors. We'll also need to create a place
for Forge to store any SCM repositories that a project might create.

for SCM in git svn hg
do
    mkdir -p ~/var/scm/$SCM
    chmod 777 ~/var/scm/$SCM
    sudo ln -s ~/var/scm/$SCM /
done

Initializing the environment

The forge consists of several components, all of which need to be running to have
full functionality.

MongoDB database server

Generally set up with its own directory, we'll use ~/var/mongodata to keep our
installation localized. We also need to disable the default distribution
server.

(anvil)~$ sudo service mongodb stop
(anvil)~$ sudo update-rc.d mongodb remove

(anvil)~$ mkdir -p ~/var/mongodata ~/logs
(anvil)~$ nohup mongod --dbpath ~/var/mongodata > ~/logs/mongodb.log &

SOLR search and indexing server

We have a custom config ready for use.

(anvil)~$ cd ~/src
(anvil)~/src$ wget http://apache.mirrors.tds.net/lucene/solr/1.4.1/apache-solr-1.4.1.tgz
(anvil)~/src$ tar xzf apache-solr-1.4.1.tgz
(anvil)~/src$ cd apache-solr-1.4.1/example/
(anvil)~/src/apache-solr-1.4.1/example/$ mkdir -p ~/src/forge/solr_config/conf
(anvil)~/src/apache-solr-1.4.1/example/$ cp solr/conf/solrconfig.xml ~/src/forge/solr_config/conf/
(anvil)~/src/apache-solr-1.4.1/example/$ nohup java -Dsolr.solr.home=$(cd;pwd)/src/forge/solr_config -jar start.jar > ~/logs/solr.log &

Forge task processing

Responds to asynchronous task requests.

(anvil)~$ cd ~/src/forge/Allura
(anvil)~/src/forge/Allura$ nohup paster taskd development.ini > ~/logs/taskd.log &

Forge SMTP for inbound mail

Routes messages from email addresses to tools in the forge.

(anvil)~/src/forge/Allura$ nohup paster smtp_server development.ini > ~/logs/smtp.log &

TurboGears application server

In order to initialize the Forge database, you'll need to run the following:

(anvil)~/src/forge/Allura$ paster setup-app development.ini

This shouldn't take too long, but it will start the taskd server doing tons of
stuff in the background. It should complete in 5-6 minutes. Once this is done,
you can start the application server.

(anvil)~/src/forge/Allura$ nohup paster serve --reload development.ini > ~/logs/tg.log &

And now you should be able to visit the server running on your local machine.
You can log in with username admin1, test-user or root. They all have password
"foo". (For more details on the default data, see bootstrap.py)

Next Steps

Generate the documentation

Forge documentation currently lives in the Allura/docs directory and can be
converted to HTML using Sphinx:

(anvil)~$ cd ~/src/forge/Allura/docs
(anvil)~/src/forge/Allura/docs$ easy_install sphinx
(anvil)~/src/forge/Allura/docs$ make html

You will also want to give the test suite a run, to verify there were no problems
with the installation.

(anvil)~$ cd ~/src/forge
(anvil)~/src/forge$ export ALLURA_VALIDATION=none
(anvil)~/src/forge$ ./run_tests

Happy hacking!