Tiki Manager | |
Tiki Manager permits you to manage various instances of Tiki. You can install, upgrade, backup, clone, check the file integrity and do various other things. This can be done on the same server or a remote server. Most actions can be run unattended on a cron job. It can be used via the command line or a web interface. Tiki Manager supercedes TRIM. Coming to Tiki25: Tiki Manager Package |
Requirements | |
It uses the Symfony Console Component.
|
Installation | |
These are general instructions for Linux. You may need to adapt for your operating system. See also Additional configuration below. At a high level:
Copy to clipboard
|
Documentation | |
Here is a brief explanation of the basic commands that can be used. All commands follow a wizard pattern. Copy to clipboard
|
instance | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
instance:createAdds an instance to be managed by Tiki Manager, which can mean either:
Copy to clipboard
Non interactive command: Copy to clipboard
instance:listCopy to clipboard
instance:accessOpens a shell to the remote host.
Params
Copy to clipboard
instance:backupTiki Manager performs a complete backup of the Tiki instance.
Copy to clipboard
instance:blankLike 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. Copy to clipboard
Copy to clipboard
instance:checkoutCheckoutCommand: allow checking out a specific Git branch and revision for main Tiki co Params
Copy to clipboard
instance:cloneMakes another identical copy of Tiki. This is basically a combination of make backup and make restore in one operation.
As two Tiki instances with the same settings (ex.: both point to the same Elasticsearch index can cause issues), recommended reading: Divergent Preferences in Staging Development Production The following are excluded from the cloning process:
Copy to clipboard
instance:cloneandredactThis command allows you to clone an instance and redact the clone,
Params
Copy to clipboard
instance:cloneandupgradeLike instance:clone but with an extra upgrade operation. As two Tiki instances with the same settings (ex.: both point to the same Elasticsearch index can cause issues), recommended reading: Divergent Preferences in Staging Development Production The following are excluded from the cloning process:
Copy to clipboard
instance:consoleAllow to run any Console command from Tiki. Copy to clipboard
Copy to clipboard
Copy to clipboard
instance:copysshkeyCopy the SSH key to the remote instance. This is used as part of other commands but can be used as standalone as well - copies the Tiki Manager SSH key to the remote machine by asking you for the password to connect to, so Tiki Manager can authenticate via its public/private key pair and skip asking for passwords on all subsequent operations. Copy to clipboard
instance:deleteDelete 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. Copy to clipboard
instance:detectDetect 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. Copy to clipboard
instance:editPermits to modify an instance. Copy to clipboard
instance:fixpermissionsRun 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`. Copy to clipboard
instance:importImport an instance to the instances list, if detects a Tiki instance, and itâs not yet managed by Tiki Manager. Params
Copy to clipboard
Non interactive command: Copy to clipboard
instance:maintenancePut instances under maintenance or live mode. Copy to clipboard
|
instance:patch | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
https://gitlab.com/tikiwiki/tiki-manager/-/merge_requests/271 instance:patch:listCopy to clipboard
instance:patch:deleteCopy to clipboard
instance:patch:applyCopy to clipboard
Copy to clipboard
instance:profile:applyApply a profile to an instance. Copy to clipboard
instance:restoreRestore 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. Copy to clipboard
instance:revertRevert a particular instance working dir to its original branch state (aka git hard reset). Thus, it removes any applied patches Copy to clipboard
instance:setup-scheduler-cronThis command allows you to enable the cron to run the schedulers Copy to clipboard
Copy to clipboard
Possible options: Copy to clipboard
instance:statsExtract stats (KPIs) from selected instances as csv. Optionally that information can be pushed to another Tiki instance. Params
Copy to clipboard
Copy to clipboard
Copy to clipboard
instance:update
Params
Copy to clipboard
instance:upgradeSimilar 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
Copy to clipboard
instance:verifyThis 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.
Copy to clipboard
instance:watchThis command perform the Hash check (instance:verify). 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
Copy to clipboard
|
backups | |||||||||||||||||||||||||||||||||||||||||||||
backups:setupSame as manager:setup-backups. Copy to clipboard
backups:deleteDelete Tiki Manager backups folder and contents. This folder contains the backups of instances managed by Tiki Manager. Copy to clipboard
backup:ignore:addAdd one or more paths to the list of ignored paths when doing backups. Helpful to avoid adding to thebackup big files or files being backup in a different way. Params
Copy to clipboard
backup:ignore:listAdd one or more paths to the list of ignored paths when doing backups. Helpful to avoid adding to thebackup big files or files being backup in a different way. Params
Copy to clipboard
backup:ignore:removeAdd one or more paths to the list of ignored paths when doing backups. Helpful to avoid adding to thebackup big files or files being backup in a different way. Params
Copy to clipboard
|
cache | |
cache:clearDelete Tiki Manager cache folder. Useful for development. Copy to clipboard
|
database | |
database:delete
Copy to clipboard
database:view
Copy to clipboard
|
logs | |
logs:clearClear Tiki Manager logs folder. Copy to clipboard
|
manager | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manager:info
Copy to clipboard
manager:check
Copy to clipboard
manager:report
Copy to clipboard
manager:setup-clone
Copy to clipboard
manager:test-send-email
Copy to clipboard
tiki:versions
Copy to clipboard
manager:reset
Copy to clipboard
manager:setup-backupsSet-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).
Copy to clipboard
manager:setup-updateSet-up a cron job 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
Copy to clipboard
manager:setup-watchSet-up a cron job on the Tiki Manager master to perform the Hash check (instance:verify) 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
Copy to clipboard
manager:updateUpdate Tiki Manager to the latest version available. This updates the PHP code from Git, and updates the Composer dependencies. Params
Copy to clipboard
Copy to clipboard
Copy to clipboard
|
Additional configuration | |
Version Control SystemTiki Manager by default uses git and public repository. If you want to use SVN (but you shouldn't as SVN is no longer supported) as your default vcs or another repository please use the following lines in your .env file. Copy to clipboard
Behind proxy or without internet connection
Setting the default VCS to src, Tiki Manager will use existing packages in the data/tiki_src folder (default). Copy to clipboard
Email settingsTo configure Tiki Manager email sender address add the following line to your .env file. Copy to clipboard
Configure SMTP ServerBy default Tiki Manager uses sendmail to send email notifications. If you intend to use SMTP instead add the following lines to your .env file. Copy to clipboard
Web Manager settingsIf you want to setup a default folder to install your web manager or apache user:group are different than apache:apache you can add the following settings to your .env file. Copy to clipboard
Copy to clipboard
|
Timeouts during long running operations | |
Add the Apache directive |
Hooks | |
Every command can have a pre and post scripts. See more context in the feature request: https://gitlab.com/tikiwiki/tiki-manager/-/issues/22 |
Adding a hook | |
Command is the name of the command being executed, replace In this example lets create a post execution hook for instance:create command
|
Hook variables | |
Copy to clipboard
Additional vars per command
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
Copy to clipboard
|
Other Notes | |
Tiki Manager vs MultiTiki | |
Using the Details[+]To list the domains in the 20.x tiki use: Copy to clipboard
Copy to clipboard
|
Troubleshooting | |
If you have weird errors and/or an inability to update, it could be
|
Source code | |
The source code is managed here:
|
Debugging | |
|
Roadmap | |
|
Related | |
alias
|