Information
2022-02: coming to Tiki25: The standalone web interface will be deprecated and replaced by an interface within Tiki. And Tiki will be enhanced to better handle background jobs. See: Tiki Manager Package


Tiki Manager Web Administration implements many of the features of Tiki Manager, the console (command line) part and is designed to be easy and simple to use. While Tiki Manager is mature and well tested, the web interface is of beta quality (as of 2021-04). Some features are missing. And there can be timeouts, so you likely will have to tweak your server settings. Basically, if the web interface works for your requirements, great. If there are issues, just revert to the command line interface. If you are interested in improving this feature, please join the community and contribute.

Screenshots

1.2. Key features

1.2.1. Instances

1.2.1.1. Create a new instance

To create a new instance, go to Instances → Create a new instance, (e.g http://example.org/create), fill in the fields on the server as shown in this example:


Scroll down to Database Settings; it is necessary to have a user with administrative privileges in order to create users and databases:

1.2.1.2. Import a Tiki instance

To import a Tiki instance, go to Instances → Import a tiki instance, once at (e.g http://example.org/import), specify the path of the instance in the "Tiki Web root" field as shown in the example below:

1.2.1.3. Delete an instance

Deleting an instance is done by going to Instances → Delete an instance, (e.g http://example.org/delete), if you click on the icon, confirm your action with a click on the “Delete” or the “Cancel” button to cancel it. Note that you do NOT delete your Tiki. The action just deletes the instance connection to Tiki Manager Web Administration.

1.2.1.4. List Instances

All your instances are displayed at (e.g http://example.org/list), Instances → List instances. On this page or on the home page, you can perform actions such as “Create a blank instance”, “Edit an instance”, “Fix an instance”, etc.

1.2.2. Manage

1.2.2.1. Update an instance

Update an instance, by going to Manage → Update an instance, (e.g http://example.org/update), and then click on an instance, a modal will open and you will see a result like this:


This operation:

  • Does a dry-run first, and aborts on any conflicts
  • Updates to latest code in that branch (or trunk) using git pull or svn up and thus merging any changes
  • And all operations should be done after updating the code
    • Updates the file hashes accordingly. The hash verification/update may prompt with some files containing conflicts if modifications were made on the instance.
    • Performs the database update.
    • Runs setup and Composer,
    • Clears cache
    • Rebuilds search index

1.2.2.2. Upgrade an instance

You can also upgrade your instance. For example to move from version 20.x to version 21.x. To do this, proceed as follows: Manage → Upgrade an instance, on the page (e.g http://example.org/upgrade); select the source instance, then select the version to be upgraded, then click on the upgrade button. A modal will open to give you the upgrade report.

1.2.2.3. Fix an instance

To fix the permissions of an instance with Tiki Manager Web Administration, proceed to Manage → Fix an instance, (e.g http://example.org/fix). On the list of your instances, set the instance of your choice by clicking on the button. This action is equivalent to running the command sh setup.sh using automated parameters.

1.2.2.4. Watch an instance

Tiki Manager Web Administration allow you to check for anomalies in an instance, proceed to Manage → Watch an instance, (e.g http://example.org/watch). On the list of instances, click on the button, a modal will appear to give you a report of the process.

1.2.2.5. Clone an instance

If you want to create an identical copy of an instance, go to Manage → Clone an instance, (e.g http://example.org/clone). On the list of your instances, select the source instance, then the destination instance and click on the "clone" button. A modal will open to give you the clone report.


Be very careful, when using another existing Tiki Instance, as the data here will be wiped and replaced by the data from the source instance.

1.2.2.6. Clone and Upgrade an instance

You can also clone, create an exact copy of an instance and upgrade it simultaneously with Tiki Manager Web Administration. Like Clone an instance with an extra upgrade operation. To do this, scroll down the "Manage" menu, click on "Clone and upgrade an instance", once on the page:

  • Select the source instance, the one you want to clone and upgrade;
  • Select the destination instance, the instance in which you want to clone and upgrade;
  • Select the version to upgrade (e.g. 21.x)
  • Click on the "Clone and Upgrade" button.

1.2.3. Backups

1.2.3.1. Backup an instance

To backup an instance with Tiki Manager Web Administration, go to Backups → Make a Backup, (e.g http://example.org/backup), and click on the relevant instance; a modal will open to show you the process and give a report.

The backup includes all files (using rsync for efficient bandwidth management) on remote host (including user files and files stored out of the web root) and a dump of the database. Each backup is archived in the backup/archive folder as a .tar.bz2 file, where Tiki Manager is installed.
The backup file contains:

  • manifest.txt: Indicates where folders were located on the remote host
  • database_dump.sql: Self-explanatory
  • [a-f0-9]{32}: Folders named using a hash. Content of the folders on remote host. The manifest.txt file lists these hashes.

1.2.3.2. Restore an instance

Go to Backups → Restore an instance, (e.g http://example.org/backup), once the instances are listed:

  • Select instance do you want to restore from;
  • Select the backup do you want to restore;
  • Select the instance do you want to restore to;
  • Click on the "Restore" button.

A modal will open and give you the report of the restore.

1.2.3.3. Manage backups

With Tiki Manager Web Administration, manage (list, delete) the backups of your instances, you can find them by going to Backups → Manage Backups, (e.g http://example.org/manage), click on an instance to access the list of backups.

1.2.4. Help

1.2.4.1. Check requirements

Help → Check requirements, (e.g http://example.org/check), allows you to get a list of Tiki Manager Web Administration requirements.

1.2.5. How to update access credentials (username/password)

To update the username and password, edit the config.php file that is located at the root of the web interface files.
Please note that reinstalling the web interface on the same exact folder, will not prompt for access credentials if the config.php file is found.

1.2.6. Too many invalid login attempts

If you get a message "Login is temporarily disabled, please contact an administrator to unlock the login process.", see webmanager:block --reset