Skip to content

Commit bcc65cd

Browse files
committed
hotfix: update docs to reflect GH docker image usage
1 parent 253cfb4 commit bcc65cd

3 files changed

Lines changed: 31 additions & 20 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ miiify-clone https://github.com/jptmoore/miiify-sample-data.git --git ./git_stor
3131
<summary><strong>Using Docker?</strong> Click to see Docker commands</summary>
3232

3333
```bash
34-
# Clone using Docker
35-
docker run --rm -v $(pwd)/git_store:/home/miiify/git_store miiify \
34+
# Clone using Docker (using pre-built image from GHCR)
35+
docker run --rm -v $(pwd)/git_store:/home/miiify/git_store ghcr.io/nationalarchives/miiify:latest \
3636
/home/miiify/miiify-clone https://github.com/jptmoore/miiify-sample-data.git --git ./git_store
3737
```
3838

@@ -85,10 +85,10 @@ miiify-import --input ./annotations --git ./git_store
8585
<summary><strong>Using Docker?</strong> Click to see Docker commands</summary>
8686

8787
```bash
88-
# Import using Docker
88+
# Import using Docker (using pre-built image from GHCR)
8989
docker run --rm \
9090
-v $(pwd)/annotations:/home/miiify/annotations \
91-
-v $(pwd)/git_store:/home/miiify/git_store miiify \
91+
-v $(pwd)/git_store:/home/miiify/git_store ghcr.io/nationalarchives/miiify:latest \
9292
/home/miiify/miiify-import --input ./annotations --git ./git_store
9393
```
9494

@@ -106,10 +106,10 @@ miiify-compile --git ./git_store --pack ./pack_store
106106
<summary><strong>Using Docker?</strong> Click to see Docker commands</summary>
107107

108108
```bash
109-
# Compile using Docker
109+
# Compile using Docker (using pre-built image from GHCR)
110110
docker run --rm \
111111
-v $(pwd)/git_store:/home/miiify/git_store \
112-
-v $(pwd)/pack_store:/home/miiify/pack_store miiify \
112+
-v $(pwd)/pack_store:/home/miiify/pack_store ghcr.io/nationalarchives/miiify:latest \
113113
/home/miiify/miiify-compile --git ./git_store --pack ./pack_store
114114
```
115115

@@ -126,9 +126,9 @@ miiify-serve --repository ./pack_store --port 10000
126126
<summary><strong>Using Docker?</strong> Click to see Docker commands</summary>
127127

128128
```bash
129-
# Serve using Docker
129+
# Serve using Docker (using pre-built image from GHCR)
130130
docker run --rm -p 10000:10000 \
131-
-v $(pwd)/pack_store:/home/miiify/pack_store miiify \
131+
-v $(pwd)/pack_store:/home/miiify/pack_store ghcr.io/nationalarchives/miiify:latest \
132132
--repository ./pack_store --port 10000 --base-url http://localhost:10000
133133

134134
# Or use Docker Compose

doc/installation.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,19 @@ Miiify can be installed using Docker or natively on Linux/macOS.
66

77
The 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
1729
docker 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

2238
All 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)

docker-compose.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,8 @@ version: "3"
22

33
services:
44
miiify:
5-
image: jptmoore/miiify:latest
5+
image: ghcr.io/nationalarchives/miiify:latest
66
build: .
7-
# Default: run miiify-serve
8-
# To run other commands, override with: docker compose run miiify <command> <args>
9-
# Examples:
10-
# docker compose run miiify /home/miiify/miiify-clone https://github.com/...
11-
# docker compose run miiify /home/miiify/miiify-compile --git ./git_store --pack ./pack_store
127
command:
138
- "/home/miiify/miiify-serve"
149
- "--repository"

0 commit comments

Comments
 (0)