(Quick Reference)

8 DbDoc Controller - Reference Documentation

Authors: Burt Beckwith

Version: 1.4.0

8 DbDoc Controller

You can use the dbm-db-doc script to generate static HTML files to view changelog information, but another option is to use the DbDocController at runtime. By default this controller is mapped to /appname/dbdoc/ but this can be customized with UrlMappings like any controller.

You probably don't want to expose this information to all of your application's users so by default the controller is only enabled in the development environment. But you can enable or disable it for any environment in Config.groovy with the dbDocController.enabled config option. For example to enable for all environments (be sure to guard the URL with a security plugin in prod):

grails.plugin.databasemigration.dbDocController.enabled = true

or to enable in the production environment:

environments {
   production {
      grails.plugin.databasemigration.dbDocController.enabled = true
   }
   …
}