The automated install process comprises a four step process and provides its own detailed on-screen instructions and help. The main installation page explained that you will have downloaded one of the two standard versions of Cliqon – either with or without a demonstration front end with associated data.
In each case you should uncompress the Zip file to web server directory of your choice. We have tried to include the necessary empty directories in the compressed file but some mechanisms for decompressing a Zip file may not honour these sub-directories.
On the first screen of the Wizard we provide the means to check the existence of the necessary sub directories and ensure that they are writable.
Cliqon requires the existence of a Configuration file that resides in /config and is known as config.cfg. The Configuration file is in TOML format. We provide a template for the Config file, named config.txt. It contains certain placeholders which will be updated from the Form on Step 2, with live values before the Config.Txt is converted to Config.Cfg.
You will need to provide the usual information to create a Database connection. In the case of SQLite, only the name of the database file is required and it is presumed to reside in /data, once created.
The form contains two form fields related to multiple languages. Every web framework that supports multiple languages has their own way of handling them. The history of Cliqon is that it was designed on the island of Mallorca where there are two official languages – Spanish and Catalan. In addition, the existence of significant numbers of residents from Great Britain and Germany, means that any web project for the island requires support for four languages. We did a great deal of research to establish the best way to handle multiple, concurrent languages and Cliqon embodies this research in its design.
We have tried as best as we can to ensure that Cliqon has no base language. If one exists in certain places – such as in error messages that we cannot acces, that language will be English. All languages are treated equally. If Cliqon is to be used in a single language environment, then one code, language name and flag should be created. The placeholders for the fields show how three languages might be handled. The key and value that make a language pair or set are separated by a vertical bar. Each pair is separated by a comma. For a single language website, you will provide one key|value pair.
You will note the Configuration file conversion process generates a set of arrays for languages. We supply English and Spanish in our demonstration.
For more information, please the Language subsection within Configuration.
You can get a simple preview of your entries on the form before pressing the Create button. You can edit the configuration file after it is created in a popup editor. It is recommended that you read the Section on Configuration in this manual before attempting a manual edit.
The third step covers three possible areas. In the case of a SQL database connection (as opposed to SQLite), if the database username and password can create a database, then you can invoke that process using the first button. If not, you will need to create the Database manually.
Creating the tables now does two tasks – creating the tables and populating them with initial and essential data. As explained previously, the dataset may consist of a basic set which contains or does not contain entries for a demonstration front end.
The reason we have to undertake the two tasks of table creation and initial data import, is because we use an ORM. Redbean does the process in reverse order, as most ORMs do, that is, it creates the columns of the table as it inserts the data for that column.
For more information, please the Database subsection within Configuration.
The third and final action on Steps 3, is the creation of the master administrative user. Who will be used to access the Administration system for the first time.
The fourth and final step reminds you to remove the installation directory and other files. Pressing finish also deletes the Blocker file as explained previously and redirects you to the Login screen for the Administration system.
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: Free help authoring tool