From bb9bf7ba6a377fbff555709742410e98725822f6 Mon Sep 17 00:00:00 2001 From: jeffvli Date: Fri, 22 Sep 2023 00:31:56 -0700 Subject: [PATCH] Add docker run instructions --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b10a9879..ff98b489 100644 --- a/README.md +++ b/README.md @@ -45,10 +45,27 @@ Rewrite of [Sonixd](https://github.com/jeffvli/sonixd). ## Getting Started -Download the [latest desktop client](https://github.com/jeffvli/feishin/releases). +### Desktop (recommended) + +Download the [latest desktop client](https://github.com/jeffvli/feishin/releases). The desktop client is the recommended way to use Feishin. It supports both the MPV and web player backends, as well as includes built-in fetching for lyrics. If you're using a device running macOS 12 (Monterey) or higher, [check here](https://github.com/jeffvli/feishin/issues/104#issuecomment-1553914730) for instructions on how to remove the app from quarantine. +### Web and Docker + +Visit [https://feishin.vercel.app](https://feishin.vercel.app) to use the hosted web version of Feishin. The web client only supports the web player backend. + +Feishin is also available as a Docker image. The images are hosted via `ghcr.io` and are available to view [here](https://github.com/jeffvli/feishin/pkgs/container/feishin). You can run the container using the following commands: + +```bash +# Run the latest version +docker run --name feishin --port 9180:9180 ghcr.io/jeffvli/feishin:latest + +# Build the image locally +docker build -t feishin . +docker run --name feishin --port 9180:9180 feishin +``` + ### Configuration 1. Upon startup you will be greeted with a prompt to select the path to your MPV binary. If you do not have MPV installed, you can download it [here](https://mpv.io/installation/) or install it using any package manager supported by your OS. After inputting the path, restart the app.