@@ -6,7 +6,19 @@ Miiify can be installed using Docker or natively on Linux/macOS.
66
77The easiest way to get started is with Docker, which includes all dependencies and commands.
88
9- ### Build the Docker image
9+ ### Pull the pre-built image
10+
11+ Docker images are automatically built via GitHub Actions and published to GitHub Container Registry:
12+
13+ ``` bash
14+ # Pull the latest image
15+ docker pull ghcr.io/nationalarchives/miiify:latest
16+ ```
17+
18+ <details >
19+ <summary ><strong >Alternative:</strong > Build the image locally</summary >
20+
21+ If you prefer to build the image yourself:
1022
1123``` bash
1224# Clone the repository
@@ -17,31 +29,35 @@ cd miiify
1729docker build -t miiify .
1830```
1931
32+ Note: If you build locally, replace ` ghcr.io/nationalarchives/miiify:latest ` with ` miiify ` in the commands below.
33+
34+ </details >
35+
2036### Using Docker commands
2137
2238All Miiify commands are available in the Docker image. You can run them using ` docker run ` :
2339
2440``` bash
2541# Clone a repository (recommended)
26- docker run --rm -v $( pwd) /git_store:/home/miiify/git_store miiify \
42+ docker run --rm -v $( pwd) /git_store:/home/miiify/git_store ghcr.io/nationalarchives/ miiify:latest \
2743 /home/miiify/miiify-clone https://github.com/jptmoore/miiify-sample-data.git --git ./git_store
2844
2945# OR: Import local annotations from filesystem (if you created files manually)
30- docker run --rm -v $( pwd) /annotations:/home/miiify/annotations -v $( pwd) /git_store:/home/miiify/git_store miiify \
46+ docker run --rm -v $( pwd) /annotations:/home/miiify/annotations -v $( pwd) /git_store:/home/miiify/git_store ghcr.io/nationalarchives/ miiify:latest \
3147 /home/miiify/miiify-import --input ./annotations --git ./git_store
3248
3349# Compile to pack store (required after clone or import)
34- docker run --rm -v $( pwd) /git_store:/home/miiify/git_store -v $( pwd) /pack_store:/home/miiify/pack_store miiify \
50+ docker run --rm -v $( pwd) /git_store:/home/miiify/git_store -v $( pwd) /pack_store:/home/miiify/pack_store ghcr.io/nationalarchives/ miiify:latest \
3551 /home/miiify/miiify-compile --git ./git_store --pack ./pack_store
3652
3753# Serve annotations
38- docker run --rm -p 10000:10000 -v $( pwd) /pack_store:/home/miiify/pack_store miiify \
54+ docker run --rm -p 10000:10000 -v $( pwd) /pack_store:/home/miiify/pack_store ghcr.io/nationalarchives/ miiify:latest \
3955 --repository ./pack_store --port 10000 --base-url http://localhost:10000
4056```
4157
4258### Using Docker Compose
4359
44- For production deployments, use Docker Compose:
60+ For production deployments, use Docker Compose (configured to use the GHCR image) :
4561
4662``` bash
4763# Start the server (default configuration)
0 commit comments