A Drupal module providing a user interface to the record cleaner service.
The module requires the private file system to be enabled. Depending on your
hosting arrangement, this may already be set up. You can confirm this by
inspecting the private file system path setting shown on the admin page at
admin/config/media/file-system
Refer to the Drupal docs if you need to configure this.
After installing the module,
- enable it in
/admin/modules, - enter your connection details to the record cleaner service at
/admin/config/services/record_cleaner, - grant the
Use record cleanerpermission to relevant roles.
Visit the /admin/help/record_cleaner page.
A DDEV configuration is provided for local development.
If not already present install DDEV.
Git clone the module from github.
At a command prompt, change to the folder where you just cloned the module and
run ddev start.
Run ddev poser.
Run ddev symlink-project.
The two latter commands are courtesy of https://github.com/ddev/ddev-drupal-contrib
For information on step debugging, see the configuration instructions.
With a browser, navigate to the url given by DDEV, probably https://record-cleaner.ddev.site and complete the normal Drupal installation
Follow the configuration instructions above to enable and configure the module.
You can run up a local copy of the record cleaner service and interact with that if you want. For the docker containers to communicate you need to add them to the same network as follows:
docker network create rc-bridgedocker network connect rc-bridge <service-container-name>docker network connect rc-bridge <drupal-container-name>
Currently the service container is calling itself recordcleanerservice-dev
and the drupal container is ddev-record-cleaner-web.
The base url you need to set in the module is then
http://recordcleanerservice-dev:8000/