From e9e7ae7c0561b42b7d6f9b430205d9dbd40030af Mon Sep 17 00:00:00 2001 From: picoHz <53327867+picoHz@users.noreply.github.com> Date: Tue, 23 Apr 2024 19:59:35 +0900 Subject: [PATCH] Add Docker installation instructions to docs --- README.md | 22 ++++++++++++++++++++++ docs/content/_index.md | 22 ++++++++++++++++++++++ 2 files changed, 44 insertions(+) diff --git a/README.md b/README.md index 6fb046d..53a8255 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,28 @@ Please note, you can change the configuration freely, but due to the instance be There are multiple ways to install Taxy. +## Docker + +Run the following command to start Taxy using Docker: + +```bash +docker run -d \ + -v taxy-config:/root/.config/taxy \ + -p 80:80 \ + -p 443:443 \ + -p 127.0.0.1:46492:46492 \ + --restart unless-stopped \ + --name taxy \ + ghcr.io/picohz/taxy:latest +``` + +To log in to the admin panel, you'll first need to create a user. Follow the steps below to create an admin user: + +```bash +docker exec -t -i taxy taxy add-user admin +password?: ****** +``` + ### Docker Compose Create a file named `docker-compose.yml` with the following content: diff --git a/docs/content/_index.md b/docs/content/_index.md index fafd9c4..00ebab7 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -22,6 +22,28 @@ sort_by = "weight" There are multiple ways to install Taxy. +## Docker + +Run the following command to start Taxy using Docker: + +```bash +docker run -d \ + -v taxy-config:/root/.config/taxy \ + -p 80:80 \ + -p 443:443 \ + -p 127.0.0.1:46492:46492 \ + --restart unless-stopped \ + --name taxy \ + ghcr.io/picohz/taxy:latest +``` + +To log in to the admin panel, you'll first need to create a user. Follow the steps below to create an admin user: + +```bash +docker exec -t -i taxy taxy add-user admin +password?: ****** +``` + ## Docker Compose Create a file named `docker-compose.yml` with the following content: