Loading...
 
(Cached)

Tiki Manager is the name of the tool that replaces TRIM. Think of it as TRIM 2.0!

It has all of the same functionality, on a modern code base.

Requirements

  • PHP 7.1 or above
  • SQLite3
  • Composer

Installation

The preferred way to install this extension is through composer.
To install Tiki Manager it is required to have composer installed.

php composer.phar install


See also: How to install Tiki Manager on ClearOS

Documentation

Here is a brief explanation of the basic commands that can be used. All commands follow a wizard pattern.

instance

instance:access

Opens a shell to the remote host.
Since Tiki Manager manages all your connections, using this command simply avoids needing to remember passwords.

php tiki-manager.php instance:access

instance:backup

Tiki-Manager performs a complete backup of the Tiki instance.
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.
php tiki-manager.php instance:backup

instance:blank

Like instance:create but it doesn't actually add a Tiki. It just creates an instance that can be used to restore or clone another instance.

php tiki-manager.php instance:blank

php tiki-manager.php instance:create blank

instance:check

This is equivalent to a secdb check, except that it's safer because it's made from a trusted host and will take your custom modifications on host into consideration. Upon first run, the check will ask where it should fetch the hashes from.

php tiki-manager.php instance:check

instance:clone

Makes another identical copy of Tiki. This is basically a combination of make backup and make restore in one operation.
The destination instance can be blank or another configured and managed Tiki Instance. Be very careful, when using existing another Tiki Instance, as the data here will be wiped and replaced by the data from the source instance.

Params

ParamsTypeDescription
modeparameterCheck if is a clone or upgrade
checkoptionCheck files checksum. Only used in mode upgrade.

php tiki-manager.php instance:clone

instance:cloneandupgrade

Like instance:clone but with an extra upgrade operation.

Params

ParamsTypeDescription
modeparameterCheck if is a clone or upgrade
checkoptionCheck files checksum. Only used in mode upgrade.

php tiki-manager.php instance:cloneandupgrade

instance:console

Allow to run any Console command from Tiki.

php tiki-manager.php instance:console

instance:copysshkey

Copy the SSH key to the remote instance.

php tiki-manager.php instance:copysshkey

instance:create

Adds an instance to be managed by Tiki Manager, which can mean either:

  • create a fresh Tiki instance (including a database)
  • or detect an existing Tiki installed via Subversion (SVN) and "adopt" it.
  • You may need to convert your Tiki instance from FTP to SVN.


Params

ParamsTypeDescription
blankoptionBlank Instance
typeoptionInstance connection type
hostoptionRemote host name
portoptionRemote port number
useroptionRemote User
passoptionRemote password
urloptionInstance web url
nameoptionInstance name
emailoptionInstance contact email
webrootoptionInstance web root
tempdiroptionInstance temporary directory
branchoptionInstance branch
backup-useroptionInstance backup user
backup-groupoptionInstance backup group
backup-permissionoptionInstance backup permission
db-hostoptionInstance database host
db-useroptionInstance database user
db-passoptionInstance database password
db-prefixoptionInstance database prefix

php tiki-manager.php instance:create

Non interactive command:

php tiki-manager.php instance:create --type=local --url=http://manager.tiki.org --name=manager.tiki.org --email=manager@tiki.org --webroot=/www/manager --tempdir=/tmp/trim_temp --branch=branches/19.x  --backup-user=www-data --backup-group=www-data --backup-permission=750 --db-host=localhost --db-user=root --db-pass=secret --db-prefix=manager


instance:delete

Delete the instance via the command line (you could also do via the web interface). This does NOT delete your Tiki. It just deletes the instance connection to it.

php tiki-manager.php instance:delete

instance:detect

Detect Tiki branch or tag, and PHP version. For debugging purposes. Also useful if you manually proceeded to svn switch and Tiki Manager needs to update its internal database about a Tiki instance.

php tiki-manager.php instance:detect

instance:edit

Permits to modify an instance.

php tiki-manager.php instance:edit

instance:fixpermissions

Run setup.sh on the remote host using automated parameters. It should work in most cases. If the command proposed my setup.sh without parameters or super user rights are required, you should connect to the remote host manually using `instance:access`.

php tiki-manager.php instance:fixpermissions

instance:maintenance

Put instances under maintenance or live mode.

php tiki-manager.php instance:maintenance

instance:profile:apply

Apply a profile to an instance.

php tiki-manager.php instance:profile:apply

instance:restore

Restore on a blank installation. Ref: instance:blank If you have data files that are not stored in the database, you should use the ideal scenario for data file storage and relative paths.

php tiki-manager.php instance:restore

instance:update

  • Does a dry-run first, and aborts on any conflicts
  • Updates to latest code in that branch (or trunk) using 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


During the update process, the instance is disabled using a .htaccess file (previous one is preserved), making the site unavailable until the update is completed.

Params

ParamsTypeDescription
modeparameterCheck if is an auto or switch mode
checkoptionCheck files checksum.

php tiki-manager.php instance:update

instance:upgrade

Similar to update. Requests for the branch to switch to over the update. You will have several choices of branches. Please note that you should NOT downgrade as Tiki doesn't support a downgrade database script. An upgrade is a one-way street! You should make a backup before you upgrade so you can return to this version if issues arise.

If you choose to do a manual upgrade (with svn switch).

Params

ParamsTypeDescription
checkoptionCheck files checksum.

php tiki-manager.php instance:upgrade

instance:verify

Verify an instance (same as check)

php tiki-manager.php instance:verify

instance:watch

This command perform the Hash check (instance:check). The script will prompt for a contact email address to notify with the log in the case of a suspicious file change (which could be an intrusion or someone who legitimately changed a file on the server).

Params

ParamsTypeDescription
emailoptionEmail address to contact.
excludeoptionList of instance IDs to be excluded, separated by comma (,)

php tiki-manager.php instance:watch

backups

backups:setup

Same as manager:setup-backups.

php tiki-manager.php backups:setup

backups:delete

Delete Tiki Manager backups folder and contents. This folder contains the backups of instances managed by Tiki Manager.

php tiki-manager.php backups:delete


cache

cache:clear

Delete Tiki Manager cache folder. Useful for development.

php tiki-manager.php cache:clear


database

database:delete

  • Delete Tiki Manager database. Useful for development.
php tiki-manager.php database:delete

database:view

  • View Tiki Manager database. For debug purposes and useful for development.
php tiki-manager.php database:view

logs

logs:clear

Clear Tiki Manager logs folder.

php tiki-manager.php logs:clear

manager

manager:report

  • Reports, and send reports to a Tiki instance using Data Channels.
php tiki-manager.php manager:report

manager:reset

  • Delete Tiki Manager backup, cache, and log files. Useful for development.
php tiki-manager.php manager:reset

manager:setup-backups

Set-up a cronjob to perform automatic instance(s) backups (instance:backup) every day at a specific time. The script will prompt for the time which the cron should run at and the instances that will be ignored by these automatic backups (all instances are selected by default).

  • Automatic backups cronjob should not run at the same time as the "manager:setup-update" cronjob command. Make sure you pick different run times.


Params

ParamsParamsTypeDescription
timeoptionTime to trigger the instance(s) backup using the format <hours>:<minutes>
excludeoptionList of instance IDs to be excluded from the backup, separated by comma (,)

php tiki-manager.php manager:setup-backups

manager:setup-update

Set-up a cronjob to perform automatic instance(s) update (instance:update) every day at a specific time. The script will prompt for the time which the cron should run at and the instances that will be affected by this automatic update.

Params

ParamsParamsTypeDescription
timeoptionTime to trigger the instance(s) update using the format <hours>:<minutes>
instancesoptionList of instance IDs to be updated, separated by comma (,)

php tiki-manager.php manager:setup-update

manager:setup-watch

Set-up a cron job on the Tiki Manager master to perform the Hash check (instance:check) automatically every day. The script will prompt for a contact email address to notify with the log in the case of a suspicious file change (which could be an intrusion or someone who legitimately changed a file on the server) and the time at which the script should run.

Params

ParamsTypeDescription
emailoptionEmail address to contact.
timeoptionThe time update should run.
excludeoptionList of instance IDs to be excluded, separated by comma (,)

php tiki-manager.php manager:setup-watch

webmanager

webmanager:enable

Enable a web interface for Tiki Manager.

php tiki-manager.php webmanager:enable


Once set up and running, it will look like this
Image

Aditional configuration


This section describes the available configuration parameters that can be used within tiki-manager's config.yml file. This file should be placed inside the "data" folder, and should follow a strict structure.

Currently accepted settings for the instance:

NamePossible valuesDescription
default_version_control_systemGIT SVNDefines the default version control system used within tiki-manager. If not set, the default tiki-manager value (SVN) will be used.
git_repository_urlGit repository URLDefines the Git repository URL to be used within tiki instances created by tiki-manager. Only new instances will be affected once this is changed. Defaults to "https://gitlab.com/tikiwiki/tiki.git"


Config.yml example:

instance:
  default_version_control_system: 'GIT'
  git_repository_url: 'https://my-repository.com/tikiwiki/tiki.git'


Source code

The source code is managed here:
https://gitlab.com/tikiwiki/tiki-manager/

Roadmap

Manager

alias

Attached files

ID Name Comment Uploaded Size Downloads
84 2019-05-15-tiki-manager-web-gui.png Marc Laporte 28.19 Kb 0

doc.tiki.org

Bootstrap AdminGuide UserGuide

Keywords

Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

Accessibility (WAI and 508)
Accounting
Articles and Submissions
Backlinks
Banners
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Link Cache
Calendar
Category
Chat
Clean URLs
Comments
Communication Center
Compression (gzip)
Contacts (Address Book)
Contact us
Content Templates
Contribution
Cookie
Copyright
Credit
Custom Home and Group Home Page
Date and Time
Debugger Console
Directory of hyperlinks
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
Draw
Dynamic Content
Dynamic Variable
External Authentication
FAQ
Featured links
File Gallery
Forum
Friendship Network (Community)
Gmap Google maps
Groups
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
Kaltura video management
Karma
Live Support
Login
Logs (system & action)
Look and Feel
Lost edit protection
Mail-in
Map with Mapserver
Menu
Meta Tags
Mobile Tiki and Voice Tiki
Mods
Module
MultiTiki
MyTiki
Newsletter
Notepad
Payment
Performance Speed / Load
Permissions
Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
Polls
Profiles
Profile Manager
Report
Toolbar
Quiz
Rating
Feeds
Score
Search engine optimization
Search
Search and Replace
Security
Semantic links
Shadowbox
Shadow Layers
Share
Shopping cart
Shoutbox
Slideshow
Smiley
Social Networks
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Stats
Surveys
Tags
Task
Tell a Friend, alert + Social Bookmarking
TikiTests
Theme CSS & Smarty
Trackers
Transitions
TRIM
User Administration including registration and banning
User Files
User Menu
Watch
WebDAV
Webmail
Web Services
Wiki History, page rename, etc
Wiki Plugin extends basic syntax
Wiki Syntax
Wiki structure (book and table of content)
Workspace
WSOD
WYSIWYCA
WYSIWYG
XMLRPC

Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki
Show PHP error messages