From solunas

Welcome to the new home of Solunas

Contents 1 Solunas Documentation 1.1 What is Solunas? 1.1.1 Public Views 1.1.2 The backend 1.1.2.1 Administrators 1.1.2.2 User's (Property Owners) 1.1.3 SOAP Web Services 1.2 The Ruby on Rails application 1.2.1 Installing and running 1.2.1.1 System requirements 1.2.1.2 Step by Step 1.2.2 Initial configuration 1.2.2.1 Understanding the data model: Users and Properties 1.2.2.1.1 Users 1.2.2.1.2 Property 1.2.2.2 Creating your own admin user 1.2.2.3 Setting up a property with rooms 1.2.2.4 Understanding prices 1.2.2.5 Configuring prices 1.2.3 Daily operation 1.2.4 Technical Reference 1.2.4.1 Public URLs 1.3 The Solunas clients 1.3.1 The PHP client 1.3.1.1 Views available through the PHP client 1.3.1.2 Installation 1.3.1.3 Integration into a website 1.3.2 The Typo3 connector 1.3.3 The Joomla connector 2 FAQ 3 About www.solunas.org and rsolunas.de

Solunas Documentation

What is Solunas?

Public Views

The backend

The password protected back-end portion of Solunas will show different menu options depending on the type user that logs in.

If an Administrator logs in, he or she will be only presented with the user administration options. An Administrator can only add, change and delete other Administrators or other regular users. The administrator cannot edit properties, rooms, prices, etc. If you run a Solunas system for yourself and you are both the user and the Administrator, you need to create two different users for that.

Administrators

User's (Property Owners)

SOAP Web Services

The Ruby on Rails application

Installing and running

System requirements

• Ruby (version 1.8 and above)
• Ruby on Rails (version 2.3 and above)
• MySQL server (version 5 and above)

Step by Step

These steps are Debian and its derivatives related. The command are in bold text.

apt-get install ruby (unless already installed - check with ruby -v)

apt-get install rubygems (unless already installed)

apt-get install rake (unless already installed)

apt-get install libopenssl-ruby (most probably RoR will stay unhappy without this library)

gem install rails (this will install Ruby on Rails 2.3.2 at present)

apt-get install mongrel (an optional web server, much faster than the default Wbrick)

The Solunas installation:

svn co https://solunas.svn.sourceforge.net/svnroot/solunas/RoR-application/tags/2.1.0/ Solunas_2.1

or just export the repository unless you need further checkouts:

svn export https://solunas.svn.sourceforge.net/svnroot/solunas/RoR-application/tags/2.1.0/ Solunas_2.1

cd Solunas_2.1

vim config/database.yml edit accordingly - (username / password)

rake db:create or create your database in the preferred way mysql -u root -p -e "create database Solunas"

mysql -u username -p -D your_solunas_db_name < db/solunas.sql

rake db:migrate the database migration process will create two users: adm/admin and user/user

ruby script/server or for production envirnoment ruby script/server -e production

(for the production env. add RAILS_ENV=production to each rake command)

Visit http://localhost:3000/ and login with the appropriate username / password.

Change Admin data and create users

Initial configuration

Understanding the data model: Users and Properties

Users

Solunas has two kinds of users which are mutually exclusive:

• Admin users
• Non-Admin users

An Admin user can only create, update and delete other users. An Admin user cannot edit properties, rooms, prices, contracts, etc.

Every Admin user has full power over all Non-Admin users in the system, not only those which he or she created!

A Non-Admin user is a user of the system; typically the manager of a property such as a guest house or a hotel. A non-admin user has no power over any other users, but he or she can create, update and delete properties and rooms, edit prices, edit customers and contracts.

Property

Technically speaking, a Property in Solunas is a container for items which can be rented by customers for periods of time. The granularity is the day. Typically, one Hotel would be one property, which has a number of rooms, which are available for rent. In theory, a Property could as well be one location of a car rental company which has a given number of cars available for rent. Practically Solunas is meant for and has been used to book rooms, appartments and houses so far. If you would try to configure a car rental with it, the cars would show up in the system as rooms.

Creating your own admin user

Setting up a property with rooms

Understanding prices

Configuring prices

Daily operation

Technical Reference

Public URLs

• http://xxx.yyyyyy.net/show_form?user_id=10
• http://xxx.yyyyyy.net/public/calendar?user_id=10&property_id=3&year=2009
• http://xxx.yyyyyy.net/public/calendar_by_year?user_id=10&property_id=3&room_id=7

The Solunas clients

The PHP client

The Solunas PHP client is a fragment of PHP code which can be used to seamlessly integrate Solunas functionality into a website which is hosted on a different server than the Solunas application itself. The PHP client is designed to work in most of today's typical LAMP webspaces. It does not contain any application logic by itself other than

• collecting user input
• sending user data to the XML-RPC based web service which the Solunas RoR application provides
• rendering responses

This separation of presentation and logic gives the designer of the website into which the Solunas views are integrated a lot of freedom to adjust the presentation of the Solunas portions to the overall look and feel of the site.

Views available through the PHP client

The PHP client offers two different views which you can integrate into a website:

• bookflow: This is the form based widget which will ask for an arrival and departure date and the number of people, then show a list of available rooms, allow the use to choose, than takes the user's personal details.
• calender: This is a calendar based availability view. The calender view may be used by a user to find an available slot in a property. It does not allow to make a reservation, but it can be linked to the bookflow of course.

Note: Some property owners prefer not to publish their availability calendar while others do. Therefore you can either decide to use the calendar view or simply leave it out.

Installation

• [[Download][1]] and unzip into your webspace. (Attention: There is a file called index.php!!!)
• Adjust parameters in the index.php file (Solunas webservice URL, username and password of the property represented by the site)

Integration into a website

You should treat the index.php file from the PHP client package as an example. The PHP code can be cut & pasted into the respective "Booking" page of your website that has the same header, footer, navigation and possibly CSS as the rest of your site.

For that reason, the index.php file itself is kept very simple; see yourself.

The Typo3 connector

The Joomla connector

FAQ

Q: Will Solunas stay free?

A: Yes. Both as on beer as well as in speech. First of all, it's GPL code, so there is little choice. But besides that, we believe in FOSS. We also believe in active participation by the user community.

About www.solunas.org and rsolunas.de

The website www.solunas.org had been started by the original founder of the Solunas project, Mr. Marc Isemann. Marc seems to have decided to leave the project. At least, he did not reply to any communication and obviously did not object to the new team taking over the project here at SourceForge. Unfortunately, despite us asking friendly and even offering some compensation, he did not react to or question if we could take the solunas.org domain over for the project. So any content on solunas.org is hardly related to what's going on here now.

The domain rsolunas.de which is hard-coded into some portions of the source code at the time we're taking over seems to belong to a paid hosting service based on Solunas. We have no information if this service still exists or not. Try to contact Mr. Isemann if you would like to find out. They will be parameters in the next release, so anyone who wants to use that service will be able to do so by just settings the right parameters.

looking for the OriginalMainPage?