Rabbit/Installing
From Dionyziz
Installing Rabbit is pretty easy. This document aims to be a comprehensive installation guide explaining the system requirements and all the necessary steps for a Rabbit installation.
Contents |
[edit] OS
Rabbit is platform independent. This means that it can run consistently on all Operating System, such as UNIX-based or Windows systems. It has been tested under Gentoo Linux and Windows XP. It has not been tested under Mac systems; if you test it under Mac, please let me know.
[edit] Apache
If you want your project to be a web project, you will, first of all, need a working web server:
Apache 1.3 and Apache 2.2 should work perfectly, but they have not been tested. You're welcome to try them out; if you do, let me know if they worked for you, or what problems exactly you faced. Other web servers have not been tested with Rabbit, but if you manage to use it somewhere else, please let me know.
Apache is not necessary if your project is a console-based application. However, Rabbit is, by default, configured for a web project. You will need to apply extensive settings modifications to be able to run your projects as non-web-based-projects. Please also keep in mind that many Rabbit features are designed for web-based projects only. The core Rabbit structure does not require your project to be a web project.
[edit] PHP
Rabbit is written in PHP5 and for PHP5. You'll need a working installation of PHP. If you're using Apache, PHP should be configured to work with your web server.
PHP4 is not supported, and there are no plans for PHP4 support. Rabbit is designed for PHP5 and is written using PHP5 standards so it is very hard to port it to PHP4. If you would like to attempt it, you're welcome to, but bare in mind that Rabbit uses several PHP5 features not available in PHP4, such as reflection, visibility, overloading, final, type hinting, automatic object references and so forth.
If you want to use Rabbit with both Apache and PHP, please make sure (by testing) that both Apache and PHP are installed correctly and are configured to work together, before starting to wonder why rabbit doesn't work!
[edit] MySQL
If you would like to use a database, Rabbit contains a MySQL wrapper for the MySQL PHP library. You don't need a database to use Rabbit, but a lot of its features are designed for projects that store their data in a database.
If you would like to use a different type of database (or a filesystem), such as PostgreSQL or FireBird, you will have to write your own wrapper extending existing Rabbit classes. This is easy to do; there are plans to ship these extensions with Rabbit in the future, they're just not available at the moment. If you write such an extension, please contact me so that I can include it in the next rabbit compilation.
[edit] Extract
Download a Rabbit compilation, and extract it into the folder you want your application to be located. The file index.php should be directly located into the folder you want your application to run from. For example, if you want your application to be located at /var/www/localhost/htdocs, make sure that the index.php file from Rabbit is located at /var/www/localhost/htdocs/index.php and not, say, /var/www/localhost/htdocs/rabbit/index.php!
[edit] Test
Test your Rabbit installation by opening a browser to your installation URL.
[edit] Now what?
Now you can just developing your project! Check the basic rabbit structure and go from there :-)
