26/11/2012

Installation Manual for SaltOS

Setup

Josep Sanz

SaltOS is distributed in 4 different packages:
  • PHP: This package contains the program SaltOS and includes everything necessary to uncompress and unpack the program online. To use this package, please download the package and leave it in a directory on your hosting visible from the Internet. Access the installation file with a browser and the screen "Welcome to SaltOS setup" appear. Follow these steps to install quickly SaltOS in your server.
  • RPM: This package is aimed at users who use RPM-based servers such as RedHat, CentOS, Fedora and many others who have chosen this package format. To install this package, simply run from a terminal with root permissions the following command: "rpm -i PACKAGE.RPM". SaltOS will be installed on your system. After installing the package, access from a browser to the url of the hosting using http://www.example.com/saltos/. This url will give access to the "Welcome to SaltOS setup". Also create a shortcut in the applications menu so you can access easily.
  • EXE: This package is aimed at users who want to try SaltOS on a computer running Microsoft Windows (XP, Vista or 7). To install this program, you must download the EXE format package on your computer and run it. The installation wizard that appears install on your computer the SaltOS program. Additionally, also installs Apache 2 and PHP 5.3 required for running the SaltOS program. If your computer already has installed these programs, use another package format. After installing the package, access from a browser to the url of the hosting using http://www.example.com/saltos/. This url will give access to the "Welcome to SaltOS setup". Also create a shortcut in the applications menu so you can access easily.
  • TGZ: This package contains the source code of SaltOS. Is aimed at expert users or for updates that do not require initial setup process provided by the "SaltOS setup".
SaltOS, creates 2 directories called:
  • code: This directory contains the source code of the application. When you want to upgrade SaltOS, simply replace this directory by the new directory code of the new package.
  • user: This directory contains the same directory structure as the code using symbolic links to the code directory. This allows the application to run in this directory, saving data and user settings, and it is separated logically from the directory containing the source code. This type of directory that contains symbolic links only, is what is called an instance of the application. If we have n instances for n companies, simply replicate the user directory, but only having 1 copy of the application source code.
SaltOS using external programs:
  • xsltproc: This program will be necessary only if the PHP installation does not support DomDocument or XSLTProcessor. In the remaining cases will never be used.
  • unoconv: This program allows to SaltOS to convert any document to PDF format for viewing with the online PDF viewer.
  • elinks: This command allows you to convert text emails and feeds downloaded. Required for email and feeds applications.
  • text2wave: This program allows you to convert text into sound. It will be necessary for the voice feature.
  • ffmpeg: This program allows you to convert .wav files to .mp3 files. It will be necessary for the voice feature.
  • apertium: This program allows you to translate text into different languages. It will be necessary for the online translation feature.
  • calc: This program allows you to perform mathematical operations. It will be necessary for the online calculator feature.
  • aspell: This program allows you to correct texts in different languages. It will be necessary for the online translator and check speller.
  • zcat: This program is only used in the installation process. If not available, the installer requires more installation time, but it will work.
  • sqlite3: This program is only used in the installation process. If not available, the installer requires more installation time, but it will work.
  • mysql: This program is only used in the installation process. If not available, the installer requires more installation time, but it will work.
SaltOS, can use 6 different drives for accessing databases:
  • SQLite (PDO): This driver uses SQLite and is recommended for simplicity of installation and the efficiency in most cases. Use the php-pdo package and normally include support for SQLite and MySQL.
  • MySQL (PDO): This driver is the same as above but using MySQL instead of SQLite.
  • SQLite (extension): This driver allows you to use sqlite native functions but usually are outdated and therefore fail the test of GROUP_CONCAT.
  • MySQL (extension): This driver allows you to use sqlite native functions and usually tend to use the latest versions happening in most cases the test of GROUP_CONCAT.
  • SQLite (binary wrapper): This driver allows those servers where no other driver work correctly the use of the sqlite binary (downloadable from http://www.sqlite.org/download.html) using communication pipes and shared files, execute queries to SQLite database enabling the smooth SaltOS function.
  • MySQL (improved extension): This driver is an evolution of MySQL native driver. It is not usually installed on the servers.


XML lines
55,003
PHP lines
13,896
JS lines
6,243
T2T lines
3,499
XSLT lines
2,645
SQL lines
1,477