From 2459814b6884c765a0f15c1a9dbef6c95db2ceb2 Mon Sep 17 00:00:00 2001 From: Korbs Date: Fri, 28 Jun 2024 17:25:30 -0400 Subject: [PATCH] Create hosting instructions --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index a2092a2..17c252a 100644 --- a/README.md +++ b/README.md @@ -59,6 +59,19 @@ This repo is only a proof of concept to see how Poke will run in Astro. A lot of - i18n doesn't activiate after 1 or 2 seconds when launching Poke (Does it matter? Not that much, but I'll like to fix that) - Searching from a video doesn't work. Error: `SyntaxError: Unexpected end of JSON input` (URL isn't set correctly) +## Hosting - Docker Compose (Recommended) +### Requirements + - Docker Engine + +### Running +Use the Docker Compose file that is provided with Poke. Copying and pasting it into other tools like Dockge and Dokemon will work too. + +Run: +```bash +docker compose up -d +``` +> Using `sudo` may be required depending on your setup + ## Build > Instructions assume you're using Bun as the package manager, which is preferred for Astro projects.