From cbd19c702d44a58f39bdcc4191ed03a26c443f4d Mon Sep 17 00:00:00 2001 From: Xyphyn Date: Sat, 22 Jul 2023 15:57:42 -0700 Subject: [PATCH] feat: add docker documentation --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b3852c9d..26d9f5ce 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ -# lemmy-svelte +# Photon An alternative web client for Lemmy with the UI of Xylo + +## Run on your own server + +Clone the repo: + +```sh +git clone https://github.com/Xyphyn/photon && cd photon +``` + +and run the docker container: + +```sh +docker build -t photon . + +# Use the env var PUBLIC_INSTANCE_URL to set the default instance URL. +docker run -p 8080:3000 -it photon:latest +``` + +There you go, you now have an instance of Photon running.