Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
juliahayward authored and DoodleBobBuffPants committed Nov 12, 2020
1 parent 2b1be16 commit 0cb042d
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,25 @@
[![Docker Auto Build](https://img.shields.io/docker/cloud/automated/flyway/flyway)][docker]

[docker]: https://hub.docker.com/r/flyway/flyway/
[docker]: https://hub.docker.com/r/flyway/flyway-azure/

This is the official repository for [Flyway Command-line](https://flywaydb.org/documentation/commandline/) images.

## Which image should I use?

There are two families of images:

- **flyway/flyway** - this image is the basic Flyway command line application, and should be your default choice.
- **flyway/flyway-azure** - this image is suitable for use in Azure Pipelines agent jobs.

## Supported Tags

The following tags are officially supported:

- [`7.0.0-beta1`, `7.2`, `7`, `latest` (*Dockerfile*)](https://github.com/flyway/flyway-docker/blob/master/Dockerfile)
- [`7.0.0-beta1-alpine`, `7.2-alpine`, `7-alpine`, `latest-alpine` (*alpine/Dockerfile*)](https://github.com/flyway/flyway-docker/blob/master/alpine/Dockerfile)

The **flyway-azure** image *only* supports alpine versions.

## Supported Volumes

Expand All @@ -37,7 +46,7 @@ Value | Description

## Getting started

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

`docker run --rm flyway/flyway`

Expand All @@ -47,6 +56,11 @@ To do anything useful however, you must pass the arguments that you need to the

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

Note that the syntax for **flyway/flyway-azure** is slightly different in order to be compatible with Azure Pipelines
agent job requirements. As it does not define an entrypoint, you need to explicitly add the `flyway` command. For example:

`docker run --rm flyway/flyway-azure flyway`

## Adding SQL files

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

0 comments on commit 0cb042d

Please sign in to comment.