Important

Major updates are in progress. Some pages and languages may not be available.

Tiki Install Directory

The Tiki install directory structure is detailed on this page.

Files

In the root of the Tiki install directory are the core *.php files used by Tiki Wiki CMS Groupware. In addition, there are several other files that you should be aware of:

  • _htaccess — Rename to .htaccess to use the Search Engine Friendly URLs (SEFURL) feature. You can also use the htaccess.sh script to accomplish this within a CRON job. See "Clean URLs" Tiki in the Tiki documentation for more information.
  • changelog.txt — Lists details of each code change made in the Tiki code repository.
  • setup.sh — Use to automatically fetch the external package dependencies and to set the correct file directory permissions. See "Setting Directory Permissions" in Tiki for Dummies Smarties for more information.
  • copyright.txt and license.txt — The Tiki copyright statement and LGPL license.
  • robots.txt — Use to control how search engines and bots "crawl" your Tiki site.
  • web_config — Used for configuration with Windows IIs servers ( web.config ).

Directories/folders

The Tiki install directory also contains the following directories/folders:

  • admin: Contains the *.php files use for the administration pages and functions.
  • backups: Used with older Tiki versions.
  • css: Contains the base CSS stylesheets used for the standard Tiki features and functions. The theme-specific CSS files are located in the styles folder.
  • db: Contains the *.sql files for creating and updating your MySQL database and the local.php file that contains your database connection information.
    {NOTE()}If you lock the installer, Tiki adds a lock file to this directory. You must manually remove this file to re-run the installer.{NOTE}
    • cert
  • doc
    • devtools
    • reports
  • dump: Default location when generating dumps (i.e., exports) of wiki pages
  • files: Default location for storing file gallery uplaods
    • templates
  • images: Used with older Tiki versions.
  • img: Contains many of the default icons and images.
    {NOTE()}If you do not store uploaded files and images in the File Gallery, Tiki uses the ../img/wiki_up/ directory.{NOTE}
  • installer: Contains the PHP files and SQL scripts used during the installation and upgrade procedures.
  • lang: Contains a directory for each supported language translation.
  • lib: Contains a directory for each library included and used by Tiki.
  • maps
  • mods: Contains the packages downloaded or offered as mods repository (site to host external add-ons) to other Tiki sites
  • modules
  • permissionscheck: Contains files to check the different permission models for a tiki installation
  • pics: Used with older Tiki versions (Contained many of the default Tiki icons and images).
  • styles: Contains a *.css file (and optional directory) for each installed theme. See Customizing Tiki Themes for more information.
  • temp: Contains directories for temporary and cache storage.
  • templates
  • templates_c: Contains cached versions of templates.
  • tiki_tests
  • vendor: Contains the external packages used by Tiki and managed by a system administration utility called composer.
  • vendor_extra: Contains some other external packages used by Tiki not managed by composer.
  • whelp: Contains the HTML web help files when generating web help from a Tiki structure. See Create Webhelp from Structure Tiki for more information.

Intended to go to a new page after this one in the "table of contents"/structure

Using the Wizards

Starting in "Tiki12" Tiki , some wizards were added to Tiki in order to help in the initial setup based on configuration templates like "Macros" (Profiles Wizard), as well as further site configuration (Admin Wizard), and to help you as site admin to collect more information from your users if you need it (Users Wizard).

{TIP()}You can mouse over the icons with a question mark in those wizards to know more about the features and preferences that are new for you. Help icon Example: {TIP}

Setup Wizard
Setup Wizard

  • Profiles Wizard
  • Admin Wizard
  • User Wizard


{TIP()}You can launch the first screen of the Set up Wizard at any time again through a link in the quickadmin module:

Setup Wizard link in the QuickAdmin module
Setup Wizard link in the QuickAdmin module

{TIP}

Profiles Wizard

This wizard shows the admin some information about the most recommended profiles to apply, either to set up your site with a featured configuration template, add some useful extra configuration, or show a demonstration of potentially interesting features for you, just with a few clicks.

It can be launched from the first screen of the Tiki Setup shown just after the admin logs in a new tiki site:

Profiles Wizard
Profiles Wizard

They allow you to initialize Tiki as an application, e.g. a blog., by means of applying one of the 4 featured configuration profiles.

Featured Profiles
Featured Profiles

1.2. Useful

They allow you to check out some potentially useful profiles for your site.

  • "Mobile" Tiki
    This profile allows to switch the site layout, text and icons to users with smartphones and tablets
  • "Debug_Mode_Enabled" / "Debug_Mode_Disabled" Tiki
    Profile Debug_Mode_Enabled will help you detect potential errors and warnings which are hidden otherwise. Once applied, you might like to apply the opposite profile: Debug_Mode_Disabled, if not changing the appropriate settings by hand.
  • "Together" Tiki
    This profile adds a simple wiki page on a side module (using the Module menupage), showing the button to start co-writing with TogetherJS
  • "Time_Sheet" Tiki
    This profile allows recording time spent on projects. It creates two trackers: one to hold the time spent, and the other with the project names. Both trackers are linked, so that project names can be chosen when entering items to the timesheet tracker.

Useful Profiles
Useful Profiles

1.3. Simple Demos

Each of these profiles create a working instance of some features, such as trackers and wiki pages customized for specific purposes, for example.

{WARNING()}They are not to be initially applied in production environments since they cannot be easily reverted and changes and new objects in your site are created for real{WARNING}

  • "Bug_Tracker" Tiki
    This profile allows you to see a tracker in action with some demo data, and a custom interface in a wiki page to add new items, as well as having them listed for you below.
  • "Dynamic_items_list" Tiki
    This profile creates two linked trackers. One that allow pre-selecting the items in a drop down list based on the items in a previous drop down field. And a second tracker that holds the options displayed in the drop down fields.
  • "Tracker_as_Calendar" Tiki
    This profile creates a tracker with some demo data and wiki interface that will be used to display and manage a Calendar of events in a fancy visual way.
  • "Voting_System" Tiki
    This profile sets up a Voting system in which only members of a group will be able to vote. It creates a tracker, 2 groups of users, one user in each group and a custom wiki page as interface to vote.

Simple Demo Profiles
Simple Demo Profiles

1.4. Profiles Wizard Completed

Last, you will see a message confirming that you are done with the Configuration Profiles Wizard, providing some links to usual places to direct the tiki admin to.

Useful Profiles
Profiles Wizard Completed

Admin Wizard

This wizard shows up for tiki admins when they first log in, enabling them to easily configure the main features of Tiki.

{TIP()}Once you start the admin wizard, you will see some screens that will allow you to easily choose the basic initial config settings in these early stages of site set up, without the need to search them through all admin panels{TIP}

First screen of the Admin Wizard
First screen of the Admin Wizard


Admin wizard sections:

1. Set up Language
2. Set up date and time
3. Set up login
4. Set up Look and Feel
5. Set up Editor Type
6. Set up Wysiwyg editor
7. Set up your Text Area
8. Set up Wiki environment
9. Set up Categories
10. Set up Structures
11. Set up jCapture
12. Set up Files Gallery & Attachments
13. Set up Main Features
14. Set up Search
15. Set up User & Community features
16. Set up some advanced options
17. Set up Namespace
18. Admin Wizard Completed

Select Editor Type: Plain Text and/or Wysiwyg

An important choice to make is to select the Editor type or types that you want to offer to your users. In some cases, a good balance between power of the plain text wiki editor and the easiness of wysiwyg is desired, to allow power users to use full wiki syntax, while allowing other groups of users to just get a Wysiwyg editor, to mimic their favourite word processing editor in their own computers.

Select Editor type/s
Select Editor type/s


You need to select "Wysiwyg" in the previous step in order to allow both editors. In the next step, you will be shown the options to indicate that you want to use "Compatible Wiki mode" (so that content from pages is stored using traditional wiki syntax).

You will have the option to choose whether the wysiwyg editor should be displayed by default, and whether to make the wysiwyg editor optional, so that power users with enough permissions granted will be able to switch the editor to the other type of editor for specific pages when and where needed. This is the recommended setup for most Tiki sites, in case you do not know which editor and options to choose.

Set up Wysiwyg editor
Set up Wysiwyg editor


If you allowed the Text Area to use plain wiki syntax, then you will be offered some options to fine tune it for your needs, which might be advisable for many sites.

{TIP()}The Syntax Highlighter might not be desired in some cases to be on by default, but it's very recommended to have it handy for your users so that they can enable it in the wiki pages they want when they need it. For such environment setup, you need to enable it and select the theme "Off (but switchable)" in the dropdown box.{TIP}

Set up Text Area
Set up Text Area

Enabling the initially disabled wizard steps

{NOTE()}Some wizard steps are initially shown as disabled (with lighter blue color in the screen), as shown above in the table of contents of the admin wizard (e.g. Set up Structures). They require a previous setting to be enabled in order to have the further options and checkboxes shown for the tiki admin un further screens.{NOTE}

Setting up the Wiki environment and enabling structures
Setting up the Wiki environment and enabling structures


Once structures are enabled, the table of contents displays that option as enabled, and it's specific settings are also shown in the corresponding wizard step.

Setting up options related to Structures
Setting up options related to Structures

User Wizard

Advertising