Improve the documentation.

This commit is contained in:
Andrea Veri
2013-08-15 16:51:57 +02:00
parent b70ba985af
commit c3a6ff83c7

View File

@@ -4,32 +4,81 @@ The Open Source Event Manager. An event management tool tailored to Free and Ope
Local Installation
==================
* install [ImageMagick](http://www.imagemagick.org/) to your system
Ruby and Ruby on Rails:
* Install Ruby v. 1.9.3, guide at https://gist.github.com/AstonJ/2896818 for CentOS.
Debian has Ruby v. 1.9.3 packaged into the Testing suite already.
* Install Apache + mod_passenger, an handy guide is available at:
http://nathanhoad.net/how-to-ruby-on-rails-ubuntu-apache-with-passenger
OSEM:
Dependencies:
* git clone https://github.com/openSUSE/osem.git on the directory you want Apache
to serve the content from. (in our example, '/srv/http/osem.example.org')
* Run bundle install for getting all the needed gems.
* Install ImageMagick with either 'yum install ImageMagick' or 'apt-get install imagemagick'
Configuration files:
* cp config/config.yml.example config/config.yml
* cp config/database.yml.example config/database.yml
* bundle install
Directories and permissions:
* cd into the root directory for your OSEM app
* mkdir storage cache system
* chown all the files and directories to the user that runs
apache. (www-data on Ubuntu / Debian, apache on CentOS/Fedora/RHEL)
Database:
* bundle exec rake db:setup
* bundle exec rake db:migrate
* bundle exec rake db:seed
* GOTO http://0.0.0.0:3000 and register a user
Prodcution Deployment
=====================
Coming soon, but basically like any other rails app...
Apache:
Configuration
=============
To make the first registered user an admin
* rails console
* hero = User.find('1')
* hero.role_ids=[3]
* Create a new vhost that should look like this:
"""
<VirtualHost *:80>
ServerName osem.example.org
DocumentRoot /srv/http/osem.example.org/public
RailsEnv development
<Directory /srv/http/osem.example.org/public>
# This relaxes Apache security settings.
AllowOverride all
# MultiViews must be turned off.
Options -MultiViews
</Directory>
</VirtualHost>
"""
* Connect to osem.example.org and register your first user. Make
also sure that Postfix is installed and configured on the system
for the confirmation mail to pass through.
Caveats
=======
If you have problems with rails console, try this in the Gemfile
To make the first registered user an admin:
* rails console
* Check for available users with 'User.all'
* If your user's ID is [1] then do: "hero = User.find('1')"
* Give yourself admin status with "hero.role_ids=[3]"
If you have problems with rails console, try this in the Gemfile:
* gem uninstall rb-readline
* gem 'rb-readline', '~>0.4.2'
If you have problems with jquery-ui try this in the Gemfile
If you have problems with jquery-ui, try this in the Gemfile:
* gem "jquery-rails", "~> 2.3.0"
Or make the needed change as explained at http://stackoverflow.com/questions/17830313/couldnt-find-file-jquery-ui.