Short installation procedure¶
In general the installation procedure is as follows:
caretakeron the server
caretaker_instanceon the server
- create keypair for the server in ExtMgm of
- install caretaker_instance on the system to monitor
- create keypairs for the instances in ExtMgm of
- add public key of caretaker server in the ExtMgm on the instances
- create instance records on the server and add the public key of the instances
- configure the tests
- configure cli or scheduler task for TYPO3 Version Update and TER Update
- configure cli or scheduler task for executing the tests.
First of all, for the serverside setup you need a working TYPO3 (if you use TYPO3 4.4 you have to use the latest caretaker from SVN). We recommend to use a web server in your local network but of course it's possible to use another one. One thing you probably need to know is that caretaker does not run under php4. So go for php5.
You have to install the TYPO3-Extensions
css_styled_content (for content display) and
tt_address (for the management of notifications). Go to the extension manager and install these prerequisites. After that, import and install the extension
caretaker and afterwards
caretaker_instance (if you want to monitor TYPO3-Installations).
Following the installation, you need to set some extension configuration values in the extension manager:
Public key for this instance¶
To make sure you have a secure communication between the caretaker and the observed instances, openssl is used to build up the connection. Thus, we need to have a public and a private key (keypair). To generate them automatically, use the update function of the extension manager (have a look at the small dropdown box on the top of the window and choose 'update!'). The required keys will be created.
(Update script - new extension manager)
Note: The first and last token (
-----BEGIN PUBLIC KEY-----|,
|-----END PUBLIC KEY-----|) are part of the keys!!!
Public key of the caretaker server¶
See above (Public key for this instance?)
Optional - caretaker server IP¶
With this entry, you are able to restrict answers given by this caretaker instance in virtue of requests from the caretaker server to a specified IP address (so the caretaker server address should be filled in). This field is optional and recommended as a security feature.
The first step of installation is done: The
caretaker_instance is working for now.
The next step is to import and install the caretaker extension using the extension manager again. If you already use an older version of the caretaker extension, just overwrite it to perform the update. After the extension manager has created the new database tables and fields, you should see a page with the main configuration options:
Email address to be used for (Cli) notifications¶
This is the email address which (Cli) notifications should be send from by the caretaker. If you leave it empty, the standard sender address of the server will be used.
Email subject for (Cli) notifications¶
This is the email subject of (Cli) notifications send by the caretaker.
Link in notification email¶
Here you are able to define the url where the caretaker frontend plugin is placed. If caretaker send cli notifications, these emails contain a reference link to the frontend of the caretaker server. The administrator or even a costumer are able to have an overview of the instance health status and a small summery of the occurred problem. The special character ### will be replaced by the NodeID of the affected instance.
For now, leave the default url. We'll come back to this option later on, after we've placed the required frontend plugin.
One of the basic tests is a simple ping on an instance. Therefore, caretaker need to know the ping command on this machine. If the default value doesn't work, try this:
/bin/ping -c 1 ### 2>&1. The special character
### will be replaced by the url of the tested instance.
After you've made your entries, save the configuration by clicking on the update button. The caretaker extension is now ready to use. The installation part is done!
Further steps about using and configuring the caretaker server are explained in chapter 'Users manual'.
Automatic Test Executiion¶
Caretaker is able to run tests automatically. This is very useful because you don't have to sit day by day on screen to execute periodically the corresponding tests.
Set up caretaker service in the TYPO3 scheduler¶
In the TYPO3 backend, go to Admin tools -> Scheduler.
You need to add two cronjobs: TYPO3 version update and the Test runner
- Click on the "new task" button at the top of the page (1).
- Select "Testrunner (caretaker)"
- Type: Recurring
300(every 5 minutes)
Do the same for TYPO3 Versionnumbers Update (caretaker), but let that run every 86400 seconds (every day).
Now setup a cronjob on your server that runs the TYPO3 scheduler every minute:
- In the dropdown on the page top, select "Setup check"
- See if everything is correctly setup
- Add the cronjob on your server:
* * * * * php -f [your caretaker installation path]/typo3/cli_dispatch.phpsh scheduler