CodexWiki v0.5 Beta 2

• Wiki

SideBar

User Login

Installation_Guide

Installation Guide

Database Installation

Use MySQL Admin, the command line or your favorite MySQL IDE to import the MySQL Backup script to your desired database. Please remember that the scripts where made using a schema of codex. If you want another schema, then please edit the script file to reflect these changes.

The database scripts can be located in the following locations:

• Stable Build
  • codex/install/migrations/{version}/codexwiki_MySQLAdminBackup.sql
  • codex/install/migrations/{version}/codexwiki_mysqldump.sql
• Nightly Build
  • codex/workbench/sql/{version}/codexwiki_MySQLAdminBackup.sql
  • codex/workbench/sql/{version}/codexwiki_mysqldump.sql

_{* {version} Is the version you are installing}

Database Migration

If you had a previous installation of Codex, you can easily upgrade by running our migration script. You can find it under:

Stable Build

/codex/install/migration/{version}/migration.cfm

Nightly Build

/codex/workbench/sql/migration/{version}/migration.cfm

_{* {version} Is the version you are installing}

Just make sure you alter your datasource in the Application.cfm file in that folder. This script will update your current wiki installation to the latest release. And yes, it will be included in every version of Codex for upgrading ease of use.

Source Code Installation

In order to install CodexWiki you must first read our requirements guide.

1. Place the codex installation anywhere in your webserver. Thanks to ColdFusion 8, CodexWiki uses per-application mappings to where it is placed in the webserver.

2. If you place codex in another location that is not the webroot then you will have to modify the following setting in the Coldbox configuration file.

Open the file config/coldbox.xml.cfm and update the AppMapping setting to match your location.

<-- <I have installed codex under a directory called codexwiki -->
<Setting name="AppMapping" value="/codexwiki" />

3. By default, CodexWiki uses the datasource called codex, which is declared in the coldbox.xml file. If you would like to change it, then open the file and change the name of the datasource where you see this.

<Datasources>
	<Datasource alias="codex" name="codex" dbtype="mysql" username="" password=""/>
</Datasources>

4. Make sure that you have Transfer 1.0, ColdBox 2.6.2 and ColdSpring 1.2 installed.

5. If you will not be using url rewrite tools such as mod_rewrite or ISAPI rewrite, then please remove the .htaccess file in the root of the application and open the coldbox.xml.cfm configuration file and set the following setting to FALSE:

<Setting name="UsingRewrite" value="FALSE" />

Codex is configured to use mod_rewrite engine by default. If you use something different, please look in the SESRewriteRules folder for the appropriate rewrite engine configuration file. If you choose not to use the rewrite engine, then all URL's will still be SEO friendly, but they will leverage ColdFusion's onMissingTemplate() feature by appending a ".cfm" to every link.

6. Fire up your browser and hit the root's index.cfm for the main wiki page.

7. The default login/password for the administrator is the following:

8. (Optional) We have a very simple script to install the verity collection and scheduler if you will be using the Verity Search engine for Codex. Out of the box, Codex is configured to use a Database Search implementation. If you choose verity, you will have to use the verity installer and then log into the codex admin and change the Search Implementation to verity from the options page.

You will find the installer in /codex/install/VerityInstaller.cfm. This will only work on Windows/Linux machines as Verity has not been ported to Mac OS X.

9. (Optional) Do you need your own custom site design? Easy, just create a coldbox layout in the /codex/layouts/custom folder and try to use the basic ColdBox layout: /codex/layouts/Layout.Main.cfm as your guide for creating your own template. Then open the coldbox.xml and change the Defaultlayout element to point to yours:

<Layouts>
	<--D<eclare the default layout, MANDATORY-->
	<DefaultLayout>custom/MyLayout.Main.cfm</DefaultLayout>
</Layouts>