akrehl/external-config

Grails 3 plugin to handle multiple config files like Grails 2.x did

External-Config

This plugin will mimic the Grails 2 way of handling external configurations defined in grails.config.locations.

IMPORTANT!

The External Config Plugin (1.1.0 and above) no longer needs to implement ExternalConfig on Application.groovy. It now uses a SpringApplicationRunListenerand hooks into the startup automagically. So if you used the plugin in prior versions, please remove implements ExternalConfig from Application.groovy

Contributors

• Sudhir Nimavat
• Dennie de Lange

Thank you!

Installation

Add dependency to your build.gradle:

dependencies {
    compile 'org.grails.plugins:external-config:1.1.2'
}

To use a snapshot-version

add JFrog OSS Repository to the repositories:

repositories {
    maven { url "https://oss.jfrog.org/repo/" }
}

and specify the snapshot version as a dependency:

dependencies {
    compile 'org.grails.plugins:external-config:1.1.3-BUILD-SNAPSHOT'
}

Usage

When you add this plugin to your Grails build, it will automatically look for the property grails.config.locations. Define this in in either application.yml like this:

grails:
    config:
        locations:
            - classpath:myconfig.groovy
            - classpath:myconfig.yml
            - classpath:myconfig.properties
            - file:///etc/app/myconfig.groovy
            - file:///etc/app/myconfig.yml
            - file:///etc/app/myconfig.properties
            - ~/.grails/myconfig.groovy
            - ~/.grails/myconfig.yml
            - ~/.grails/myconfig.properties
            - file:${catalina.base}/myconfig.groovy
            - file:${catalina.base}/myconfig.yml
            - file:${catalina.base}/myconfig.properties

or in application.groovy like this:

grails.config.locations = [
        "classpath:myconfig.groovy",
        "classpath:myconfig.yml",
        "classpath:myconfig.properties",
        "file:///etc/app/myconfig.groovy",
        "file:///etc/app/myconfig.yml",
        "file:///etc/app/myconfig.properties",
        "~/.grails/myconfig.groovy",
        "~/.grails/myconfig.yml",
        "~/.grails/myconfig.properties",
        'file:${catalina.base}/myconfig.groovy',
        'file:${catalina.base}/myconfig.yml',
        'file:${catalina.base}/myconfig.properties',
]

Notice, that ~/ references the users $HOME directory. Notice, that using a system property you should use single quotes because otherwise it's interpreted as a Gstring.

The plugin will skip configuration files that are not found.

For .groovy and .yml files the environments blocks in the config file are interpreted the same way, as in application.yml or application.groovy.

Getting configuration from another folder than /conf on classpath without moving it with Gradle script

If you wish to make your Grails application pull external configuration from classpath when running locally, but you do not wish to get it packed into the assembled war file (i.e. place the external configuration file in e.g. /external-config instead of /conf), then you can include the external configuration file to the classpath by adding the following line to build.gradle:dependencies

providedCompile files('external-config') // providedCompile to ensure that external config is not included in the war file

Alternatively, you can make a gradle script to move the external configuration file to your classpath (e.g. /build/classes)

Scripts

This plugin also includes two scripts, one for converting yml config, to groovy config, and one for converting groovy config to yml config. These scripts are not guaranteed to be perfect, but you should report any edge cases for the yml to groovy config here: https://github.com/virtualdogbert/GroovyConfigWriter/issues

Sample usage:

grails yml-to-groovy-config [ymlFile] [optional outputFile]
grails groovy-to-yml-config [ymlFile] [optional outputFile]