Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ximdex
committed
Oct 18, 2012
1 parent
a9aec58
commit 5b66239
Showing
6,706 changed files
with
1,096,455 additions
and
0 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,270 @@ | ||
| Ximdex - INSTALLATION procedures | ||
| -------------------------------- | ||
|
|
||
| Installing Ximdex is easy but not trivial. Ximdex is distributed as TAR (or TGZ) files, debian or RPM packages, Virtual machines, etc. | ||
|
|
||
| Before starting the installation check if you comply with the requeriments and dependencies. | ||
| If you are directly installing from a TGZ file, after moving the code to its "natural" place (a directory served by your HTTP server, as described in Section A - PREPARATION), an installation script has to be executed in order to install&configure your Ximdex instance (as described in Section B - INSTALLATION). This "install.sh" bash script will ask you some basic parameters as mysql passwords, paths, urls, and so on. If it is your first time with Ximdex, we recommend you to install using the default projects and modules. | ||
|
|
||
| A note about Ximdex versions: last Ximdex version is available in Brazilian portuguese, German, English and Spanish. It can be directly downloaded from Ximdex.com or external repositories as a TGZ file. Previous versions of Ximdex are also available as debian, rpm and oracle virtual machine packages. | ||
|
|
||
| Feel free to contact us at help@ximdex.org for further assistance. | ||
|
|
||
|
|
||
| Installation Requirements and dependencies: | ||
| ------------------------------------------ | ||
| - PHP (>= 5.1). | ||
| - PHP modules: php5-xsl, php5-cli, php5-curl, php5-gd, php5-mysql, php-pear, php5-suhosin(recommended). | ||
| - To allow spelling check using Xedit (our XML editor): php5-enchant module. | ||
| - Other packages: wget. | ||
| - Apache 2 web server. | ||
| - Apache modules: libapache2-mod-php5, apache-mpm-worker(recommended). | ||
| - MySQL Server (>= 5.1). | ||
| - A MySQL user with write permissions on Ximdex database schema. | ||
| - Permissions on file system: Write permission for the application user on 'data' and 'logs' folders. Also, write permission on publication destiny. | ||
| - For the client side: Firefox web browser (>=3.6) with Javascript y cookies enabled. Also, 'Spanish' selected as browser default language. | ||
| - An internet connection (if you want to use the based on external reference annotations or remote publication). | ||
| - A disk partition with enough free space for Ximdex. See 'conf/diskspace.conf' file for further information. | ||
| - Virtual Box (if you want to run Ximdex from the '.ova' virtual machine). | ||
| - Sendmail (if you want to use notification by mail as it's defined by default). Otherwise, configure your 'conf/mail.conf' | ||
|
|
||
| See http://www.ximdex.org/documentacion/requisitos_es.html for further information and http://www.ximdex.org/descargas.html for additional flavours of Ximdex and old versions. | ||
|
|
||
|
|
||
|
|
||
| SECTION A - PREPARATION: preparing the instance to be installed: | ||
| --------------------------------------------------------------- | ||
|
|
||
| In order to prepar your Ximdex instance before installation, please choose one method from this section: | ||
|
|
||
|
|
||
| Installing from a TGZ or TAR file (preferred method for uptodate versions): | ||
| --------------------------------- | ||
|
|
||
| If you downloaded a '.tgz' package: | ||
|
|
||
| 1) Untar the package in your web server root folder (i.e: /var/www, /var/www/html, ...). We'll use '/var/www/'. Choose the right one for you: | ||
| >$ cp <current_path>/ximdex-VERSION_open_rREVISION.tgz /var/www/ | ||
| >$ cd /var/www/ | ||
| >$ tar zxvf /var/www/ximdex-VERSION_open_rREVISION.tgz | ||
|
|
||
| By default, your instance will be named as 'ximdex_VERSION' | ||
|
|
||
| 2) Continue the installation in SECTION B - INSTALLATION | ||
|
|
||
|
|
||
| Installing from a RPM package: | ||
| ----------------------------- | ||
|
|
||
| If you downloaded a '.rpm' package: | ||
|
|
||
| 1) We recommend to use the package manager 'yum' to perform the installation. You can execute it in your console as follow: | ||
|
|
||
| ># yum install ximdex-VERSION.all.rpm | ||
|
|
||
| If you prefer not to use 'yum', you can also execute in your console: | ||
|
|
||
| ># rpm -ivh ximdex-VERSION.all.rpm | ||
|
|
||
| By doing this, your Ximdex root folder will be placed by default on '/var/www/html/' and it will be named as 'ximdex_VERSION' | ||
|
|
||
| 2) Continue the installation in SECTION B - INSTALLATION | ||
|
|
||
|
|
||
| Installing an Oracle Virtual Machine (OVA file): | ||
| ----------------------------------------------- | ||
|
|
||
| If you downloaded a '.ova' virtual machine: | ||
|
|
||
| 1) Install Virtual Box: | ||
|
|
||
| If you did not install Virtual Box: | ||
| - Download it from http://www.virtualbox.org/wiki/Downloads | ||
| - Install it (it will reboot the system) -> further information in http://www.virtualbox.org/manual/UserManual.html | ||
|
|
||
|
|
||
| 2) Launch Virtual Box. | ||
|
|
||
|
|
||
| 3) Import the virtual machine: | ||
|
|
||
| Choose one of the following method: | ||
|
|
||
| 3.A) Automatic: | ||
|
|
||
| Browse your filesystem and double click the '.ova' file. | ||
|
|
||
| 3.B) Manually: | ||
|
|
||
| In the menu, select 'File' ('Archivo') and 'Import appliance' ('Importar servicio virtualizado') | ||
|
|
||
| Press 'Select' ('Seleccionar') button and explore your file system to choose the downloaded '.ova' file | ||
|
|
||
| Press 'Import' ('Importar') button to start to import the virtual machine. | ||
|
|
||
|
|
||
| 4) Launch Ximdex virtual machine: | ||
|
|
||
| Once importation has finished, double click the virtual machine called 'Ximdex VERSION' on the left side, or select it and press the 'Start' ('Iniciar') button (on top). | ||
|
|
||
|
|
||
| 5) Launch Ximdex instance: | ||
|
|
||
| Once virtual machine has been started, double click the direct access located in your desktop named 'Start Ximdex'. It will open your Ximdex instance in your browser. | ||
|
|
||
|
|
||
| 6) You're done. Enjoy Ximdex! | ||
|
|
||
|
|
||
| Installing from a DEBIAN repository or package: | ||
| ---------------------------------------------- | ||
|
|
||
| Debian users can use a debian package or our Debian Repository (highly recommended option for Debian Lenny users). Get your Ximdex instance from our Debian Repository as follow: | ||
|
|
||
| - DEBIAN Lenny users (installing from our debian repository): | ||
| ------------------ | ||
|
|
||
| 1) Add our repository to your source list open the file '/etc/apt/sources.list' as privileged user and add the line: | ||
|
|
||
| deb http://ximdex.org/repository/debian binary/ | ||
|
|
||
| 2) Update your repository list, typing in your console as privileged user: | ||
|
|
||
| ># apt-get update | ||
|
|
||
| 3) Install the package from our repository, typing in your console: | ||
|
|
||
| ># apt-get install ximdex | ||
|
|
||
| 4) Your Ximdex root folder will be placed by default on '/var/www/', as 'ximdex_VERSION' | ||
|
|
||
| 5) Check that your Ximdex root folder has the right user and group assignments for your apache web server. | ||
| For example, if your chosen user is 'ximdex' and your Apache group is 'www-data', type in your console as root: | ||
|
|
||
| ># chown -R ximdex:www-data /var/www/ximdex_VERSION | ||
|
|
||
| 6) Installation has be automatically done by Debian. Visit the URL http://localhost/ximdex_VERSION to enjoy Ximdex! | ||
|
|
||
|
|
||
| - Other DEBIAN users (installing from a .deb package): | ||
| ------------------ | ||
|
|
||
| If you downloaded a '.deb' package (This option is not recommended for Debian Lenny users, use instead our Debian Repository in the previous section) | ||
|
|
||
| 1) We recommend to use the package manager 'gdebi' to perform the installation. You can execute it in your console as follow: | ||
|
|
||
| ># gdebi ximdex-VERSION.all.deb | ||
|
|
||
| Or, if you prefer not to use 'gdebi', you can also execute: | ||
|
|
||
| ># dpkg -i ximdex-VERSION.all.deb | ||
|
|
||
| 2) By doing this, your Ximdex root folder will be placed by default on '/var/www/' and it will be named as 'ximdex_VERSION' | ||
|
|
||
| 3) Restarting MySQL and Apache services is recommended, specially if dependant packages were installed. | ||
|
|
||
| 4) Continue the installation in SECTION B - INSTALLATION | ||
|
|
||
|
|
||
|
|
||
|
|
||
| SECTION B - INSTALLATION to install and configure your Ximdex instance: | ||
| ---------------------------------------------------------------------- | ||
|
|
||
| To start this section you should have a Ximdex instance installed in a directory under your web root. Debian Lenny users of our repository and OVA installations do not have to execute this step. | ||
|
|
||
|
|
||
| Please, follow these steps to install and configure your Ximdex instance... | ||
|
|
||
| 1) Move to the location of Ximdex (<ximdex_home>). | ||
|
|
||
| 2) Run the install script of Ximdex as a privileged user (it is important to run it from the <ximdex_home>): | ||
|
|
||
| >$ sudo bash ./install/install.sh | ||
|
|
||
|
|
||
| 3) Follow the installation instructions and fill the requested data: | ||
|
|
||
| 3.1) Set the MySQL server url. By default, 'localhost'. | ||
|
|
||
| >$ Database server [localhost]: | ||
|
|
||
| 3.2) Set the MySQL Admin user name. By default, 'root'. | ||
|
|
||
| >$ Admin database user [root]: | ||
|
|
||
| 3.3) Set the MySQL Admin user password. Password should be typed twice. | ||
|
|
||
| >$ Admin database password: | ||
| >$ Admin database password (repeat): | ||
|
|
||
| 3.4) Set the database name to load all the Ximdex data. By default, 'ximdex'. If provided database already exists, the system will ask if you want to overwrite it, use it, or provide a new one. | ||
|
|
||
| >$ Database name [ximdex]: | ||
|
|
||
| 3.5) Set the database user. The database name provided in the last step will be taken as default value as database user. | ||
|
|
||
| >$ Database user [<XIMDEX_DB_NAME>]: | ||
|
|
||
| 3.6) Set the database user password. Password should be typed twice. If the typed user is the Admin provided above, password will not be asked again. | ||
|
|
||
| >$ Database user password: | ||
| >$ Database user password (repeat): | ||
|
|
||
| 3.7) Insert the url to access Ximdex with the browser. Like: 'http://my_domain/<XIMDEX_CURRENT_FOLDER>'. By default, 'http://localhost/<XIMDEX_DB_NAME>' | ||
|
|
||
| >$ Ximdex host [http://localhost/<XIMDEX_DB_NAME>]: | ||
|
|
||
| (it is important for Ximdex to work that you use this declared URL and do not change it to synonyms as IP numbers or other hostnames) | ||
|
|
||
| 3.8) Insert the Ximdex local path. By default, '/var/www/<XIMDEX_DB_NAME>'. | ||
|
|
||
| >$ Ximdex path [/var/www/<XIMDEX_DB_NAME>]: | ||
|
|
||
| 3.9) Set Ximdex Admin user name. By default, 'ximdex'. | ||
|
|
||
| >$ Ximdex admin user [ximdex]: | ||
|
|
||
| 3.10) Set Ximdex Admin user password. Password should be typed twice. | ||
|
|
||
| >$ Ximdex admin password: | ||
| >$ Ximdex admin password (repeat): | ||
|
|
||
| 3.11) Set your interface language by default. Ximdex will show you at this point a list of available language, and you should choose one. By default, 'Spanish (es-ES)'. | ||
| >$ Select your Ximdex default language choosing betweeen: | ||
| 1. English | ||
| 2. Spanish | ||
| 3. German | ||
| 4. Portuguese | ||
|
|
||
| Ximdex default lenguage[1]: | ||
|
|
||
| 3.12) Decide if you want to help us to improve (optional). | ||
| >$ Would you like to help us to improve sending information about Ximdex usage? (recommended) [y/n]: | ||
|
|
||
| 3.13) Install test projects on Ximdex (optional). We provide three projects to allow you to start working with Ximdex right away! | ||
|
|
||
| >$ Do you want to install one of our demo project? [y/n]: | ||
| Available projects: | ||
| 1. AddressBook | ||
| 2. Picasso | ||
| 3. The_Hobbit | ||
|
|
||
| 3.14) Optionally, decide if you want to install a set of recommended basic modules (ximIO, ximSYNC, ximNEWS,ximTAGS), in order to ensure the full functionality of Ximdex | ||
|
|
||
| >$ Do you want to install our recommended modules? [y/n]: | ||
|
|
||
| 3.15) Optionally, publishing processes have to be added to your crontab (i.e.: to sync to remote servers and to generate news bulletins), | ||
|
|
||
| >$ Do you want to add Automatic and Scheduler to your crontab? [y/n]: | ||
|
|
||
| 4) In any moment after installation, you can install additional Ximdex modules. They are avaliable on '<XIMDEX_HOME>/modules/' folder: | ||
|
|
||
| >$ ./install/module.sh install <MODULE_NAME> | ||
|
|
||
|
|
||
| 5) Now, go to the browser and type the Url provided in step 3.7 (default: http://localhost/<XIMDEX_DB_NAME>) | ||
|
|
||
|
|
||
| That's all folks. Enjoy Ximdex! | ||
|
|
Oops, something went wrong.