Official Flyway Docker images

[DEPRECATED] For Flyway 6 or newer releases, please use https://hub.docker.com/r/flyway/flyway

This is the official repository for Flyway Command-line⁠ images.

Supported Tags

The following tags are officially supported:

• 5.2.4, 5.2, 5, latest (Dockerfile)⁠
• 5.2.4-alpine, 5.2-alpine, 5-alpine, latest-alpine (alpine/Dockerfile)⁠
• 5.1.4, 5.1 (Dockerfile)⁠
• 5.1.4-alpine, 5.1-alpine (alpine/Dockerfile)⁠
• 5.0.7, 5.0 (Dockerfile)⁠
• 5.0.7-alpine, 5.0-alpine (alpine/Dockerfile)⁠

Preview Release Tags

The following tags are for unsupported preview releases:

• 6.0.0-beta2 (Dockerfile)⁠

Supported Volumes

To make it easy to run Flyway the way you want to, the following volumes are supported:

Flyway Edition

You can switch between the various Flyway editions by setting the FLYWAY_EDITION environment variable to any of the following values:

Getting started

The easiest way to get started is simply to test the image by running

docker run --rm boxfuse/flyway

This will give you Flyway Command-line's usage instructions.

To do anything useful however, you must pass the arguments that you need to the image. For example:

docker run --rm boxfuse/flyway -url=jdbc:h2:mem:test -user=sa info

Adding SQL files

To add your own SQL files, place them in a directory and mount it as the flyway/sql volume.

Example

Create a new directory and add a file named V1__Initial.sql with following contents:

CREATE TABLE MyTable (
    MyColumn VARCHAR(100) NOT NULL
);

Now run the image with the volume mapped:

docker run --rm -v /my/sqldir:/flyway/sql boxfuse/flyway -url=jdbc:h2:mem:test -user=sa migrate

Adding a config file

If you prefer to store those arguments in a config file you can also do so using the flyway/conf volume.

Example

Create a file named flyway.conf with the following contents:

flyway.url=jdbc:h2:mem:test
flyway.user=sa

Now run the image with that volume mapped as well:

docker run --rm -v /my/sqldir:/flyway/sql -v /my/confdir:/flyway/conf boxfuse/flyway migrate

Adding a JDBC driver

Flyway ships by default with drivers for

• Aurora MySQL
• Aurora PostgreSQL
• CockroachDB
• Derby
• H2
• HSQLDB
• MariaDB
• MySQL
• Percona XtraDB Cluster
• PostgreSQL
• SQL Server
• SQLite
• Sybase ASE

If your database is not in this list, or if you want to ship a different or newer driver than the one included you can do so using the flyway/drivers volume.

Example

Create a directory and drop for example the Oracle JDBC driver (ojdbc8.jar) in there.

You can now let Flyway make use of it my mapping that volume as well:

docker run --rm -v /my/sqldir:/flyway/sql -v /my/confdir:/flyway/conf -v /my/driverdir:/flyway/drivers boxfuse/flyway migrate

Adding Java-based migrations and callbacks

To pass in Java-based migrations and callbacks you can use the flyway/jars volume.

Example

Create a directory and drop for a jar with your Java-based migrations in there.

You can now let Flyway make use of it my mapping that volume as well:

docker run --rm -v /my/sqldir:/flyway/sql -v /my/confdir:/flyway/conf -v /my/jardir:/flyway/jars boxfuse/flyway migrate

Docker Compose

To run both Flyway and the database that will be migrated in containers, you can use a docker-compose.yml file that starts and links both containers.

Example

version: '3'
services:
  flyway:
    image: boxfuse/flyway:5.2.4
    command: -url=jdbc:mysql://db -schemas=myschema -user=root -password=P@ssw0rd -connectRetries=60 migrate
    volumes:
      - .:/flyway/sql
    depends_on:
      - db
  db:
    image: mysql
    environment:
      - MYSQL_ROOT_PASSWORD=P@ssw0rd
    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    ports:
      - 3306:3306

Run docker-compose up, this will start both Flyway and MySQL. Flyway will automatically wait for up to one minute for MySQL to be initialized before it begins to migrate the database.