How to set up a Zikula sandbox

From FedoraProject

(Difference between revisions)
Jump to: navigation, search
m (Fedora Insight specific modules)
(Update with latest info.)
Line 12: Line 12:
 
<pre>yum install zikula php-mbstring <zikula_module_pkg...></pre></li>
 
<pre>yum install zikula php-mbstring <zikula_module_pkg...></pre></li>
 
The {{package|php-mbstring}} package is not strictly required but may be helpful for some content or modules.</ol>
 
The {{package|php-mbstring}} package is not strictly required but may be helpful for some content or modules.</ol>
 +
 +
<li>Install the Zikula modules selection.  As of now (Dec 2009) we use every packaged module on Fedora Insight.
 +
<pre>yum install zikula-module-*</pre></li>
 +
 +
<li>Finish the installation of Scribite (the visual editor module)
 +
<pre>yum install xinha<br />cd /usr/share/zikula/javascript<br />mkdir scribite_editors<br />cd scribite_editors<br />ln -s /usr/share/js/xinha-0.96-0.1.b2 xinha</pre></li>
 +
 +
<li><strong>To take a publictest instance to live or staging:</strong></li>
 +
 +
<li>Take a dump of the publictest zikula database, and import it into a new database on your staging machine (instructions below) (if you do this, you do not need to run the install script below)</li>
 +
 +
<li>Copy the contents of /usr/share/zikula/config/templates to your staging machine.</li>
 +
 +
<li>Copy /usr/share/zikula/themes/fedora to your staging machine</li>
 +
 +
<li>Visit the site in your browser (probably at /zikula) and check it's running ok.  If it is, you need go no further in your setup.  Importing a publictest instance skips most of the setup.
 +
<pre><em>Note: all customisations should be stored either in the theme, or in the config directory.  Excluding the installation of scribite, copying<br /> the contents of these directories and the database should be enough to replicate the publictest instance</em></pre></li>
  
 
== System setup ==
 
== System setup ==

Revision as of 20:42, 15 December 2009

This page explains how to set up a Zikula installation on your local system. You can use this for testing packages or other content before deployment.

Contents

Package installation

  1. Switch user to the root account:
    su -
    Provide the system administrator password at the prompt.
  2. If you have not already done so, install the Apache web and MySQL servers:
    yum groupinstall 'Web Server' 'MySQL Database'
  3. Install the Zikula package, the PHP mbstring package, and any other modules needed:
    yum install zikula php-mbstring <zikula_module_pkg...>
  4. The Package-x-generic-16.pngphp-mbstring package is not strictly required but may be helpful for some content or modules.
  • Install the Zikula modules selection. As of now (Dec 2009) we use every packaged module on Fedora Insight.
    yum install zikula-module-*
    </li>
  • Finish the installation of Scribite (the visual editor module)
    yum install xinha<br />cd /usr/share/zikula/javascript<br />mkdir scribite_editors<br />cd scribite_editors<br />ln -s /usr/share/js/xinha-0.96-0.1.b2 xinha
    </li>
  • To take a publictest instance to live or staging:</li>
  • Take a dump of the publictest zikula database, and import it into a new database on your staging machine (instructions below) (if you do this, you do not need to run the install script below)</li>
  • Copy the contents of /usr/share/zikula/config/templates to your staging machine.</li>
  • Copy /usr/share/zikula/themes/fedora to your staging machine</li>
  • Visit the site in your browser (probably at /zikula) and check it's running ok. If it is, you need go no further in your setup. Importing a publictest instance skips most of the setup.
    <em>Note: all customisations should be stored either in the theme, or in the config directory.  Excluding the installation of scribite, copying<br /> the contents of these directories and the database should be enough to replicate the publictest instance</em>
    </li>

    System setup

    1. If you have not already done so, configure and start the services you just installed:
      chkconfig httpd on
      chkconfig mysqld on
      service httpd start
      service mysqld start
    2. Make sure that the firewall allows traffic on port 80 (HTTP). Use system-config-firewall to perform this task if needed.

    When you are finished, you should be able to open a Web browser, visit the URL http://localhost, and see the Fedora test page.

    Note.png
    Pre-existing Apache server
    If you didn't follow the steps above, because you already have a working Web server, you may need to run service httpd reload for the Zikula configuration file to be loaded by Apache.

    Set up database

    1. If you have not already done so, set up the MySQL database server. First, provide a root password:
      mysqladmin -u root password
      Warning (medium size).png
      Do not use root account password
      Do not provide the system administrator's password for your Linux system here. Use a different strong password, since this is a separate authentication for a MySQL user called "root."
    2. Create a database for Zikula:
      mysqladmin -u root -p create zikula
      Note.png
      Manual vs. automatic
      By installing the database here, you don't have to give your Zikula application the password for the MySQL "root" user.
    3. Grant rights for a zikula user on this database:
      mysql -u root -p
      <Enter password for MySQL "root" account>
      GRANT ALL PRIVILEGES ON zikula.* TO zikulaadmin@localhost IDENTIFIED BY 'new_password_here';
      FLUSH PRIVILEGES;
      QUIT;
    4. The zikulaadmin account and the new password you used above are the ones you will use in Zikula's installation process shortly.

    Zikula installation

    1. Make the Zikula configuration file writable by changing its SELinux context:
      chcon -t httpd_sys_content_t /etc/zikula/config.php
    2. Open a Web browser and point it at http://localhost/zikula (or the appropriate host name if you're running the Web browser on a different system).
    3. Click the link for the install script.
    4. Follow the prompts. First select the appropriate language (e.g. English) and select Next.
    5. Read and then accept the license by clicking the Accept license button.
    6. The checklist should be completed. Click the Next button to proceed.
    7. Use the following database information:
      Database type:   MySQL
      Table type:      MyISAM
      Host:            localhost
      Username:        zikulaadmin
      Password:        <password>
      Database name:   zikula
      Table prefix:    zk
      
      Do not check the box for Create database. Click Next to proceed.
    8. For installation type, select Complete, and then select Next to proceed.
    9. Now you will create a Zikula administrator account. This is the information that a user types into the Zikula Web interface to log in, and is separate and distinct from the database account you created earlier. Fill out the form, using a real email address (which you can change later), and select Next to proceed.
    10. The Tour module is an appropriate start page for now. Select Next to proceed.
    11. Select a theme and Next to proceed.
    12. Read the credits if desired, and then click the Go to your Zikula site link.

    Move install and update bits

    When you try to manage your Zikula sandbox, Zikula will complain unless you make the following changes, still using the root account:

    cd /usr/share/zikula
    ls -d install* upgrade* | xargs -i mv '{}' '{}-orig'
    chmod 444 /etc/zikula/config.php

    Install AuthFAS for FAS Authentication

    AuthFAS allows users to log into Zikula using their FAS credentials. If they have not logged in before, they will be registered on the Zikula system as default users. Any users in the cmsadmin group on FAS will automatically become administrators on any and every instance of Zikula. zikula-module-fasauth is in the infrastructure repository (precise instructions on how to install AuthFAS are to follow).

    Once the files are installed, there are three further changes to make. First, log into your Zikula instance, and find the 'Modules' module (in the 'System' tab of the admin panel). In the resulting list, find, initialize and activate the AuthFAS module. Next, find the 'AuthPN' module (usually in the same tab of the admin panel). Here, replace the current 'AuthPN' string with 'AuthFAS,AuthPN' (without the quotes) and save the form. Lastly, move modules/AuthFAS/config/personal_config.php to config/personal_config.php. This file contains the URL string to use for FAS - there are two possible settings, one for debug and one for production. If you are reading this, you probably want the debug version, which is the default. Once you have completed these steps, installation of AuthFAS is complete and you should be able to login using your FAS username and password.

    Note.png
    Keep a non-FAS admin account
    We recommend keeping an administrator account which is not tied to the FAS system, so that should FAS go offline for any reason, the Zikula instance admin panel can still be accessed..

    Short URLs System

    To get the fancy directory based URL scheme (such as http://www.example.com/News/2009/06/03/my_cool_article.htm) you will need some directives in either a .htaccess placed in the root directory of your Zikula instance, or alternatively the same ruleset added to your Apache .conf file. Short URLs can then be switched on through the administration interface. Click the 'System' tab, then the 'Settings' tab.

    Important.png
    Congratulations, you're done!
    Now you can log in to Zikula with the administrator account you just created, and start learning.

    Fedora Insight specific modules

    To set up a Fedora Insight specific instance, you'll need the following packages (some of which are already detailed in the list above).

    These are in repos.

    zikula-module-crpTag-0.1.3-3.el5
    zikula-module-fedora-fasauth-0.2-2.el5
    zikula-1.1.2-3.el5
    zikula-module-News
    zikula-module-pagemaster
    ziula-module-filterutil
    

    These are on their way to being in repos, but for now here is a link to the f11 rpm (other architectures often available in the parent directory).