Xarigami

resources

installing xarigami

Posted by: Jo on December 6, 2010 |  Updated: December 30, 2011 01:18 PM

quick start guide to installing xarigami cumulus

Once you have uploaded the Xarigami files to your webspace, or checked out the files from Monotone as in the first step 'Prepare for install' below, the install process should take about 5 minutes.

1. Prepare for install

2. Select your language

3. Acknowledge licence

4. Check system and file requirements

5. Database settings

6. Administrator account

7. Complete install and Launch

Security considerations

8. What's next?

 

1. Prepare for install

  1. Upload files or checkout from monotone
    1. Move the zip or tarball of xarigami files to your webspace and unzip/untar it, or
    2. If you are using Monotone, pull the main xarigami core branch and then checkout the files to your workspace.
    3. Once you have your files in place you should see the following main file and directory structure:
         html - your web root 
                   lib main core and 3rd party code libraries
                         / adodb - middleware adodb database files
                         / xarigami - core files
                   themes - directory containing all core and 3rd party themes             scripts  - directory for 3rd party script files 
                   modules - the directory containing all core and 3rd party modules
                   var     - a directory where configuration and variable data is stored                   / cache - cache file directory and subdirectories (must be writeable by the web server)                  / messaging - messaging template files 
                         / locales - locale data for translations                   / uploads - data directory for uploaded files             index.php - main file through which all files are served             install.php - main install file             upgrade.php - main upgrade file             robots.txt - robots utility file             val.php - utility file             ws.php - utility file  sites  - In or outside web root (customisable) for var directories of one or more sites
      1. NOTE: You can move the lib directory and var directory out of your main web root and also change the name of the html web root directory. You need to update your config.system.php file to do this and it can be done later if required.
    4. Check your config.system.php file
      1. Check to see if the file config.system.php exists in the var subdirectory. If it doesn't exist then you must create it:
        • Copy the config.system.php.dist file and rename it to config.system.php
        • Make sure the config.system.php file is in the var subdirectory and is writable by the web server. On a Linux (*nix) system, you should make sure by setting it as chmod 666
      2. Make sure that the var/cache directory and all of it's own subdirectories (templates, adodb and rss) are writable. On Linux set the all the directories as writeable with chmod 777.
      3. Look in the /var/locales directory. If the language of your choice is not listed as a directory, download the required language pack, extract the files and place them in the /var/locales directory of your Xaraya installation.
    5. Make sure your database connection information is available. You will need this during the install process including:
      1. Database Host name. This is the name of the host where the database server is located. In most instances it will be sufficient to use localhost or 127.0.0.1 as the host name. You can also use a fully qualified domain name such as mydomain.hosting.com for example, or the IP address for the server. 
      2. Database Username The username that will be used to connect to the database. This should not be the root database username for security reasons, but should allow you to create database tables and indexes.
      3. Database Password The database password used to connect to the database.
      4. Database Type This is the type of database you are using and currently should be the value of either MySQLSQLiteor PostgreSQL. This will be selectable from a drop down list during installation.
      5. Database Name The name of the database you are going to connect to. The installation process will create it if it does not already exist. For people on Virtual Hosting, you may already have a database created for you. In this case you should find out the name of the database.
      6. Database Table Prefix This is a unique prefix added to all database tables created by Xaraya. This enables you to run more than one Xaraya site from the same database if necessary. The prefix defaults to xar.

    Please be aware that the information is CASE SENSITIVE so be careful when noting down the information.

    Back to top

    2. Select your language

    When you are ready, browse to your site and specify the install.php file in the URL to proceed:

    http://yoursite.com/install.php 

    Select your locale (language and encoding) from the drop down list box and click on Continue to move to the next step.

    If your language does not appear in the drop down box, you can install an additional locale with a language pack once installation is complete.

    Back to top

    3. Acknowledge licence

    Read the licence terms which are those required by the GNU General Public Licence Version 2. If you read and acknowledge the terms, click on the Radio Button to signify your acknowledgement, and then click on Continue to proceed to the next step.

    If you do not acknowledge the licence you will not be able to install Xarigami.

    Back to top

    4. Check system and file requirements

    This step checks to make sure your version of PHP is adequate, and configuration files and cache file directories can be written to.

    If you see a FAILURE here for any of the file or directory checks, check that you have set sufficient write permissions for the particular file or directory. 

    Click on Continue to proceed to the next step.

    Back to top

    5. Database settings

    The information displayed in this screen is the default information in the var/config.system.php configuration file. It is important that you enter your specific database information on this screen form. Enter your previously prepared database connection information:

    • Host Name: Enter your database host name, usually localhost
    • User Name: Enter your own username required to connect to your database
    • Password: Enter the password required to connect to your database
    • Database Name: Enter the name of the database
    • Table Prefix: Enter the table prefix - it is safe to leave the default xar table prefix
    • Database Type: Select from the drop down list.

    You should also note the Create the database checkbox. If you *do not* have an existing database, then check this box and the installation process will create a database with the name you enter in the Database Name field. In some instances, especially in a Virtual Hosting Account setup, the database will already have been created for you or you may have to create the database first from your account control panel. In this case *do not* check the Create the database checkbox.

    Click on Continue to proceed to the next step.

    If you are reinstalling you wil be prompted to confirm you wish to overwrite any data in your existing database tables.

    You will see the Initialising Database screen. Please wait until the initialisation process is complete and you will be redirected to the next input form.

    Back to top

    6. Administrator account

    Once initialisation is complete, you will be prompted for a name and password for your Administrator who has full access to all areas of your site. Once your site is setup up, you can change the settings, or setup more site administrator accounts.

    • Display Name: You can enter any display name here for the Site Administrator account, or just accept the default.
    • Username: Accept the default Admin as a username if you wish, or type in another - keep to upper and lower case characters.
    • Email: Enter the default email address for the Site Administrator Choose and enter a password. It is best to use upper and lower case characters and integers - no special characters. The password is case sensitive, and is the key to your site, so please make sure you note it well.
    • Password again: Enter your password again to validate it
    • Email: Enter the default email address for the Site Administrator

    Click on Continue to proceed to the next step.

    Back to top

    7. Complete install and Launch

    If all has gone as it should have, you will soon see the Installation Complete screen.

    Congratulations! You now have a new Xarigami site. Click on the Launch the Site link to go to the front page of your new site, already logged in as Administrator.

    Please make sure you pay particular attention to Security Considerations!

    Security considerations

    Before you start exploring your new site, for security reasons, please take the time to do the following, as soon as possible:

    1. Delete the install.php file from your website document root directory.
    2. Delete the upgrade.php file from your website document root directory.
    3. Change the access for your configuration file config.system.php file to read only. In Linux set the file chmod 444.

    Now you can go and explore your new site!

    Back to top

    8. What's next?

    You should familiarise yourself with the main components of the Xarigami site. There are some steps that you should probably always carry out first before proceeding to install new themes or module.

    For an overview and quick start read "Xarigami - The Basics"

    Back to top

Related project :

xarigami core

 
« prev     next»

useful? share it.