Prerequisites

• Docker must be installed and running.

Starting a connector (using in-memory database and in-memory Redis)

The connector requires a SQL database and Redis to run. By default, the docker image will run using an in-memory H2 database and in-memory Redis cache. This mode is intended to quickly get a connector up and running but all data will be lost on container restarts. As such, this mode should not be used for any real world applications.

To start the latest nightly image of the java-ilpv4-connector in an interactive terminal, run:

docker run -p 8080:8080 -it interledger4j/java-ilpv4-connector:nightly

You should see a log message like the following once the container has successfully started:

Started ConnectorApplication in 6.912 seconds

You can now send HTTP requests to the connector to verify it's working:

curl  http://localhost:8080/accounts -H 'Authorization: Basic YWRtaW46cGFzc3dvcmQ='

Starting a connector (using external Postgres database and external Redis)

This mode requires having a Postgres database and Redis cache already running. This mode allows the java-ilpv4-connector to be restarted without loss of data (so long as the Postgres database and Redis cache are not lost).

Running Postgres and Redis in docker

If you already have a Postgres database and Redis cache running, skip this section. Otherwise, we'll start up a Postgres container and Redis container in docker.

To start a Postgres database, run:

docker run --name connector-postgres -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_DB=connector -d postgres

To start a Redis cache, run:

docker run -d -p 6379:6379 redis

You can verify the containers are running via:

docker ps

Configuring java-ilpv4-connector to connect to external Postgres and Redis instances:

The docker container needs to be configured with the postgres and redis connection details. This is done by passing environment variables in the docker run command. Docker supports passing each environment variable as a separate argument or by providing a env file that contains environment variable mappings.

For example, here is how to configure and run the connector using separate env args:

docker run -p 8080:8080 -e spring.profiles.active=insecure,postgres,migrate -e redis.host=host.docker.internal -e spring.datasource.url=jdbc:postgresql://host.docker.internal:5432/connector -e spring.datasource.username=postgres -e spring.datasource.password=postgres -it interledger4j/java-ilpv4-connector:nightly

Or more conveniently, we can put all the same args into a file named connector.env with the following contents:

spring.profiles.active=insecure,postgres,migrate
redis.host=host.docker.internal
spring.datasource.url=jdbc:postgresql://host.docker.internal:5432/connector
spring.datasource.username=postgres
spring.datasource.password=postgres

and start the connector via:

docker run -p 8080:8080 --env-file ~/connector.env -it interledger4j/java-ilpv4-connector:nightly

Configuration flags available via docker

java-ilpv4-connector uses Spring Boot for external configuration. Spring properties specific to the java-ilpv4-connector can be found under Connector Configuration Properties. Spring makes it easy to set/override a Spring property via environment variables. For example, a Spring property specified via yaml configuration like this

interledger:
    connector:
        nodeIlpAddress: test.xpring-dev.java1

can be set in an env file to docker like this:

interledger.connector.nodeIlpAddress=test.xpring-dev.java1

For Spring properties that use yaml list like:

interledger:
  globalRoutingSettings:
      staticRoutes:
        - targetPrefix: test.connie.alice
          peerAccountId: alice

The equivalent env-file override would be:

interledger.connector.globalRoutingSettings.staticRoutes.0.targetPrefix=test.connie.alice
interledger.connector.globalRoutingSettings.staticRoutes.0.peerAccountId=alice

Configuring Java VM options with docker

​Java JVM options can be configured by setting the docker environment variable _JAVA_OPTIONS

For example, to configure the Java VM with a 512mb max heap and G1 garbage collector:

docker run -e _JAVA_OPTIONS="-XX:+UseG1GC -Xmx512m" -p 8080:8080 -it interledger4j/java-ilpv4-connector:nhartner

Or if using a ENV file, then add the following line to the file:

_JAVA_OPTIONS=-XX:+UseG1GC -Xmx512m