Skip to content

Commit

Permalink
Add Docker installation instructions to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
picoHz committed Apr 23, 2024
1 parent aa925dd commit 669eef6
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
22 changes: 22 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 669eef6

Please sign in to comment.