Auto-apply migrations/metadata when the server starts (config v2)
Hasura ships a special Docker image which can be used to automatically apply migrations/metadata when the server starts:
This container image includes the Hasura CLI at
can be used for running any other CI/CD scripts in your workflow.
config v3, see Auto-apply migrations/metadata when the server starts.
metadata directories created by the Hasura CLI in
a Hasura project can be mounted at the
/hasura-metadata path of this Docker container and the container's
entry point script will apply the migrations and metadata before
starting the server. If no directory is mounted at the designated paths,
the server will start ignoring the migrations and/or metadata.
If you want to mount the migrations/metadata directories at some location other than the above, set the following environment variables:
Once the migrations and metadata are applied, the container resumes operation as a normal Hasura GraphQL engine server.
# Start Hasura after applying the migrations and metadata present in the Hasura project
docker run -p 8080:8080 \
-v /home/me/my-project/migrations:/hasura-migrations \
-v /home/me/my-project/metadata:/hasura-metadata \
-e HASURA_GRAPHQL_DATABASE_URL=postgres://postgres:@postgres:5432/postgres \
Applying only metadata
If you're managing migrations with a different tool and want to use this
image to apply only the metadata, mount the
metadata directory of your
Hasura project at the
/hasura-metadata path of this Docker container
the container’s entry point script will apply the metadata before
starting the server.