From 26769fd7c05b6fcc1de383cfbee09a8ee9cf6c27 Mon Sep 17 00:00:00 2001 From: jollySleeper Date: Sun, 8 Dec 2024 19:15:33 +0530 Subject: [PATCH] docs(installation): docker image installation steps --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 89c295b..14a079c 100644 --- a/README.md +++ b/README.md @@ -163,11 +163,24 @@ Change the docker-compose file to your liking and run `docker-compose up -d` to ### Docker (Built) -There's a [docker image](https://github.com/PussTheCat-org/docker-libremdb-quay) made by [@TheFrenchGhosty](https://github.com/TheFrenchGhosty) for [PussTheCat.org's instance](https://libremdb.pussthecat.org). You can use that as well. +Use the pre-built images from github packages using `docker pull ghcr.io/zyachel/libremdb:latest` to pull latest images. + +To run the container with pulled image use the following command. +> Note: Env file is required for running this image. Download and edit this [env file](https://github.com/zyachel/libremdb/blob/main/.env.local.example). + + +```sh +docker/podman run \ + --detach \ + --name "libremdb" \ + -p 3000:3000 \ + --env-file "path_to_env_file" \ + ghcr.io/zyachel/libremdb:latest +``` OR -Use the pre-built images from github packages using `docker pull ghcr.io/zyachel/libremdb:latest` to pull latest images. +There's a [docker image](https://github.com/PussTheCat-org/docker-libremdb-quay) made by [@TheFrenchGhosty](https://github.com/TheFrenchGhosty) for [PussTheCat.org's instance](https://libremdb.pussthecat.org). You can use that as well. ## Miscellaneous