Warden is for busy people managing multiple websites. It provides a central dashboard for reviewing the status of every website, highlighting those with immediate issues which need resolving.
Presently Warden monitors Drupal websites. Drupal websites need to install the Warden Drupal module in order to connect to Warden.
On the roadmap is a pluggable system allowing Warden to be used flexibly for any website which has a supporting connector module.
Warden is built using the Symfony2 web development framework.
Symfony2 uses Composer to manage its dependencies, if you don't have Composer yet, download it following the instructions on http://getcomposer.org/ or just run the following command:
curl -s http://getcomposer.org/installer | php
Warden also has a dependency on Mongodb, so this will need to also be installed and PHP configured to use it.
Once these dependencies have been installed you will need to follow these steps to get your application started:
- Run 'composer update' to install the Symfony application fully
- Run './scripts/clear-cache.sh @dev' to clear the cache and rebuild the assets (for dev environment)
Once set up you can log in using the credentials that you entered during the installation process.
The installation parameters are:
- locale - the language code (e.g. en), currently only en is supported
- secret - a long random string used for security
- protocol - how warden should be accessed, either https (recommended) or http (not secure)
- public_key_file - the location of where the Warden app will create the public key
- private_key_file - the location of where the Warden app will create the private key
Once a site has been 'registered' via the Warden Drupal module, the site is in a 'pending' state before all the data for that site has been requested by Warden.
To update Warden with the latest information for the sites and from Drupal.org, the following script will need to be run:
./scripts/cron.sh @ENV [new]
This will perform a full update of all the sites registered with Warden. @ENV is the environment to run cron on (e.g. @dev, @test or @prod)
The new parameter can be passed to this script which will only tell Warden to only update the sites that are in a 'pending' state.
Warden is shipped with a set of bash scripts which can be used to update the site and Drupal module information.
In order to keep the site and module information up to date, you will need to setup a cron entry to run the script:
./scripts/cron.sh @ENV new
This will update any sites in a 'pending' state and update their data within Warden.
It is recommended to run this as often as you can - ideally every 5 minutes, as this should be a relatively short process to run as it is only importing new sites.
The script currently, will check the time on the server and if it is between 04:00 and 04:05 the script will do a full update of all the site data and the Drupal module data.
It is recommended that this application should be run under SSL to maintain the security of the data and the system. For that reason this application has the security set to 'force' to run under SSL by default.
During installation you will need to set the protocol parameter to https for secure SSL or http for insecure if your server does not support SSL.
You can change this setting in app/config/parameters.yml file after installation
Using this application without SSL will be at your own risk.
A couple of things for you to be aware of with this application:
-
User credentials: If you need to regenerate the user credentials run:
php app/console deeson:warden:install --regenerate -
There is a custom CSS file generated in the following directory:
src/Deeson/WardenBundle/Resources/public/css/warden-custom.css
If you want to override any of the styling of the application edit this file and then run:
./script/clear-cache.sh [ENV]
Where [ENV] is the environment that you are running on - @dev/ @test/ @prod
test