Skip to content

Commit 0a786d8

Browse files
committed
docs(docker): Add usage instructions for pre-built Docker image
1 parent d740fdb commit 0a786d8

1 file changed

Lines changed: 16 additions & 7 deletions

File tree

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,33 +23,42 @@ The easiest way to get started is to use the public version hosted at **[mc-mod-
2323

2424
This version is automatically built and deployed by Vercel directly from the `main` branch of this repository. You can view the [deployment history here](https://github.com/IsAvaible/AngularModUpdater/deployments/Production).
2525

26-
---
27-
2826
### 2\. Self-Hosting with Docker
2927

3028
You can also run the application on your own machine using Docker.
3129

3230
**Prerequisites:**
3331

34-
- [Git](https://git-scm.com/)
32+
- [Git](https://git-scm.com/) (only required for building from source)
3533
- [Docker](https://www.docker.com/products/docker-desktop/)
3634

37-
**Instructions:**
35+
#### Option A: Build from Source
3836

39-
1. **Clone the repository:**
37+
Follow these steps to build the Docker image yourself.
4038

39+
1. **Clone the repository:**
4140
```bash
4241
git clone https://github.com/IsAvaible/AngularModUpdater.git
4342
cd AngularModUpdater
4443
```
45-
4644
2. **Build & run the Docker container:**
4745
```bash
4846
docker rm minecraft-mod-updater
4947
docker build -t minecraft-mod-updater .
5048
docker run --name minecraft-mod-updater -p 8080:8080 --restart unless-stopped minecraft-mod-updater
5149
```
52-
The application will be accessible at `http://localhost:8080`. The container will be called `minecraft-mod-updater` and will restart automatically unless stopped.
50+
51+
#### Option B: Use the Pre-built Image
52+
53+
For a faster setup, you can pull and run the pre-built image from the container registry to skip the manual build step.
54+
55+
```bash
56+
docker rm minecraft-mod-updater
57+
docker pull ghcr.io/isavaible/angularmodupdater:main
58+
docker run --name minecraft-mod-updater -p 8080:8080 --restart unless-stopped ghcr.io/isavaible/angularmodupdater:main
59+
```
60+
61+
After using either method, the application will be accessible at `http://localhost:8080`. The container will be called `minecraft-mod-updater` and will restart automatically unless stopped.
5362

5463
## Contributors
5564

0 commit comments

Comments
 (0)