You have downloaded the Cliqon install ZIP from the Cliqon web site. You have uncompressed the Zip file into the root of the production or development web site. You will have attempted to run the site and been presented with the Wizard install setup. However for one reason or another you wish to setup the website manually. The steps in the process mostly cover the same areas as the automated process.

Check Directories

Please ensure that the following subdirectories exist and that they are writable. All references start at “/” (root):

/tmp, /cache, /log, /config, /admin/cache, /admin/config, /views/uploads and /views/thumbs

Copy and edit the Config file

In the /install/config subdirectory is a dummy configuration file entitled, Config.Txt. Copy this file to /config and rename to Config.Cfg.


Edit the Config file with a text editor. You will observe that it is in TOML format. For more information on TOML please read the appropriate section in this documentation. In principle, TOML is a method for presenting or storing a multi dimensional array in a straightforward and readable format.


There are certain sections and entries in the TOML that require attention and amendment before the new Cliqon system can be used. It should be noted that Config.Cfg is effectively single langauge and all the entries within the subarray “site” can be overwritten with multi-lingual entries within the Administration system.


The Config file holds the main database access configuration. We draw your attention to the original purpose of the Config.Txt file (that you copied over) is to act as template for a Configuration and during the process of installation, template variables wrapped in curly brackets {} will be overwritten with actual values. This is particularly relevant for the database subarray where all of the entries need to be amended to actual values. The ORM within Cliqon depends upon the existence of the PDO drivers so that it can provide an equal activity, irrespective of the SQL Server or Sqlite variety in use.


You will replace the values wrapped in curly brackets, change the the default values to values appropriate for your use of Cliqon.


Below the main site subarray are two sets of entries for the languages. As explained previously, Cliqon requires entries here, even if the system is single language.


For a single language you would enter:


[site:idioms]

en = ‘English’


And for multiple languages, you might enter


[site:idioms]

en = ‘English’

fr = ‘Francais’


If you wish to use flag icons in your front end website design you might enter:


[site:idiomflags]

en = ‘english.png’

fr = ‘french.png’


As part of your website design process, if you want language flags, you will place them in an appropriate directory of the /views subdirectory such as /views/img.


When you choose to create the system manually, you have no suitable way to enter an administrative username and password for the first time you login to the Admin system. The solution we have adopted to is to record an override in the configuration file. You should complete the details manually. Once you have logged into the Admin system for the first time and have the opportunity to create Administrators and Operators in the database, it would be sensible to remove this subarray from the Configuration file as it will no longer be needed.


Some of the entries in the configuration file and within the site subarray are optional, such as a Google API key for use by Gmaps.Js as an example. You are welcome to add more entries to the Configuration file for your own purposes and we will explain in the section on Configuration how to access these values.

Setup the Database

Having completed the initial edit of the configuration file, you can proceed to setup the database. You will use a SQL editor of your choice, such as MySQL Workbench, Dbeaver or a browser based SQLite editor to create the base database. Obviously you will create this database in line with the entries that you have made in the Configuration file.

Import the tables, columns and database

If you are using a SQL Server to store the Cliqon data, use the same SQL editor to import the tables, columns and data into the database. Look in the /data subdirectory and you will find a series of SQL files that correspond to the tables in the database or schema. Open the file in a Query and execute it, restore it using data import or just simply name and run the file. Each SQL file will setup its columns and restore its data (if appropriate). As an example, “dbcollection” holds all the records to run the administrative system and more, whilst “dbitem” contains only a table columns create function. Please remember to “USE” the database you have just created. Once you have imported the data manually, you may want to delete these files from the filesystem.


If you are using Sqlite, visit the Cliqon website to download the latest Sqlite database template that you can use to start the Cliqon system. When you have downloaded the file and unzipped it, you will rename it to whatever you entered as the dbname variable and it is accessed from the /data subdirectory.

Delete the blocking file

The reason that Cliqon executes the install routine, rather than displaying the main web page, is the existence of the “notinstalled” blocking file. Once you have edited the Config file and setup the database, you can delete the “notinstalled” file and the main system will run.

Delete the install files and directories

See the main or parent Installation page to remind yourself which files and subdirectories you can safely delete once the installation is complete.

Login to Administration

Finally you can login into the Administration system. The landing page for a production Cliqon system or the demonstration system, both contain links to the Administration system which is accessed via http://sitename.com/admin/. You may wish to provide an link from your own design to the Admin system.

Create a proper administrator in the database

Having logged into the system you should create your own Administrator and system Operators before deleting the admin users sub array from the Configuration file.

Finally

After installation you may wish to review and make changes to the elements of the Configuration file - /config/config.cfg. Information about the purposes for the various entries will be included in the following sections of the Documentation. Your attention is drawn particularly to a small section about two thirds of the way through the sub-array entitled "Site" where a default entry for emergency access to the system is shown. You will want to delete this section from your production system. However for more details as to how Emergency Access is used, please visit the Section Administration -> Operators.


Finally, if not mentioned or suggested elsewhere in the Documentation, you can and should remove the Install Directory. However, installation cannot be automatically be rerun with renaming the install blocker file.


Created with the Personal Edition of HelpNDoc: Full-featured Help generator