Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
RB v6: Installation
How to install your own version of RB on your server
You will need:
- A server with Debian GNU/Linux v6 squeeze or later
- An internet domain name pointing at your server
- Root access on the server for configuration
- The postgresql database
- The apache2 web server with mod_perl
- An MTA like exim or sendmail for sending emails
Compatability with other operating systems
All Debian-based systems like for example Ubuntu should be mostly similar. Other brands of GNU/Linux will work, but you will have to modify the installation instructions for the differences. The same goes for other "Posix" variants like Mac os X, BSD, etc. It may even be possible to use the system om M$ Windows with some code modifications.
Set up a working webserver, a working postgresql installation and a working MTA. Decide on a username to use for the installation. Your personal login account should be ok, or you can create one specifically for RB. But do all your work logged in as the project user, except for the parts that need root access.
Apt is the system for installing components in a debian-based system. You may install some of the needed components by
rbuser@myrb:~$ sudo apt-get install apache2 postgresql rbuser@myrb:~$ sudo apt-get install perl libapache2-mod-perl2 git
You may install RB in a sub-directory on your web server or even in a user-directory. I will give examples for installation to the rg subdirectory to www.myrb.org pointing to the default document root of /var/www on your server. You should give yourself all the options by modifying /etc/apache2/sites-available/default replacing "AllowOverride None" with "AllowOverride All" in the "Directory /var/www/" section.
Create /var/www/rg and give ownership to your project user. You should be able to put up an index.html file (with any text content) in your directory and access it from your browser over the WWW. For example on www.myrb.org/rg/
Check that you can send emails using your MTA. You may check that by mailing yourself from the command line using the mail command.
Downloading the code
Give your project user write access in /usr/local. One way of doing this is adding your project user to the group staff and giving the group staff write access in /usr/local. Use git to download the needed projects to the directory:
rbuser@myrb:/usr/local$ git clone firstname.lastname@example.org:aigan/paraframe2.git rbuser@myrb:/usr/local$ mv paraframe2 pf rbuser@myrb:/usr/local$ git clone email@example.com:aigan/rdfbase6.git rbuser@myrb:/usr/local$ mv rdfbase6 rb
What the above means is that you in your shell console is logged in to your server myrb as your project user rbuser and moved to the directory /usr/local. Standing in that directory you will run git with the given parameters as shown above.
Installation of Perl modules
RB is using a whole lot of Perl modules. One example of a Perl module is Date::Manip. All Perl modules are availible on CPAN. You may search for and read Perl module documentation on search.cpan.org, but you should do the installation of Perl modules with Debian apt or the cpan command line program. Most installed perl modules comes with manual pages accessible through the man command, as in man Date::Manip.
Debian uses a naming standard for Perl module packages. For example, Date::Manip is packaged as libdate-manip-perl and the Perl module DateTime::Format::Pg is packaged as libdatetime-format-pg-perl. Not all Perl modules are packaged as debian packages. But you should use them if they exist.
The cpan command line program will download, compile, test and install any perl module for you. It will also download and isntall any dependencies. You may install all perl modules by using cpan, but you should use the debian packages if they are availible.
For a more pleasant cpan interface, you should install Term::ReadKey and Term::ReadLine::Perl by doing
rbuser@myrb:~$ sudo apt-get install libterm-readline-perl-perl
Follow the instructions located in paraframe/INSTALL. In short:
- Install the large amount of perl modules availible in Debian by using sudo apt-get install ...
- Running perl Makefile.PL will trigger cpan to interactively install all the other needed modules.
- Create the /etc/apache2/conf.d/paraframe configuration file.
You may run make test to see that everything was installed.
You may now continue with RDF::Base.
- Install the slightly less large amount of perl modules by using sudo apt-get install ...
- You may skip the step about setting up the DB. But do it if you want to run the tests.
- Run perl Makefile.PL to make cpan install the rest of the dependencies.
The make test will actually create a database and run some tests on it. This is optional.
Those instructuctions should be sufficient. Please ask for help if needed.