Play Remote Configuration

Remote configuration for Play Framework

---

About this project

In production, it is not always easy to manage the configuration files of a Play Framework application, especially when it running on multiple servers. The purpose of this project is to provide a simple way to use a remote configuration with a Play Framework application.

Available providers

Provider	Classpath	Repository
AWS DynamoDB	io.playrconf.provider.DynamoDbProvider	play-rconf/play-rconf-dynamodb
CoreOS etcd	io.playrconf.provider.EtcdProvider	play-rconf/play-rconf-etcd
GIT	io.playrconf.provider.GitProvider	play-rconf/play-rconf-git
HashiCorp Consul	io.playrconf.provider.ConsulProvider	play-rconf/play-rconf-consul
HTTP	io.playrconf.provider.HttpProvider	play-rconf/play-rconf-http
Redis	io.playrconf.provider.RedisProvider	play-rconf/play-rconf-redis

Add play-rconf to your project

build.sbt

resolvers += "jitpack" at "https://jitpack.io"

libraryDependencies += "com.github.play-rconf" % "play-rconf" % "release~YY.MM"

How to use

You can use this project in two ways. The first is to simply set the right application loader in your configuration file. The second, if you have an existing application loader, is to extend it with the class provided in this project : io.playrconf.ApplicationLoaderJava or io.playrconf.ApplicationLoaderScala.

application.conf (first way)

play {
  application {

    ## Application Loader
    # https://www.playframework.com/documentation/latest/JavaDependencyInjection
    # https://www.playframework.com/documentation/latest/ScalaDependencyInjection
    # ~~~~~
    loader = "io.playrconf.ApplicationLoaderJava"
    #loader = "io.playrconf.ApplicationLoaderScala"
  }
}

ApplicationLoader.java (second way)

import io.playrconf.ApplicationLoaderJava;

public class ApplicationLoader extends ApplicationLoaderJava {

    @Override
    public GuiceApplicationBuilder builder(final Context context) {
        final GuiceApplicationBuilder newInitialBuilder = super.builder(context);
        // Your custom code
        return newInitialBuilder;
    }
}

Configuration

## Remote configuration
# ~~~~~
# Allows usage of remote configuration. Configuration is fetched at
# the application start and merged into the the local configuration
# file
remote-configuration {

  # Providers to use. If you specify more than one, they will all
  # be used one after the other. The variable could be a single
  # string or a list of string containing the classpath of all
  # providers to use
  providers = [
  ]
  providers = ${?REMOTECONF_PROVIDERS}

  # Alternative way to specify the provider to use. The variable
  # must be a single string containing the classpath of the provider
  # to use
  provider = ""
  provider = ${?REMOTECONF_PROVIDER}
}

License

This project is released under terms of the MIT license.