1
mirror of https://github.com/qbittorrent/qBittorrent synced 2024-10-08 02:36:22 +02:00

Revise Docker document

Currently Docker Inc. recommends installing Docker Desktop instead of the CLI.
docker-compose has been deprecated, replaced by docker compose.

PR #17448.
This commit is contained in:
清靈語 2022-08-01 13:10:47 +08:00 committed by GitHub
parent 1c0479a795
commit ef297dd8e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

22
dist/docker/Readme.md vendored
View File

@ -1,16 +1,18 @@
# qBittorrent-nox Docker Image
This Dockerfile allows you to build a docker image containing qBittorrent-nox
This Dockerfile allows you to build a Docker Image containing qBittorrent-nox
## Prerequisites
In order to build/run this image you'll need `docker` installed: https://docs.docker.com/get-docker/
In order to build/run this image you'll need Docker installed: https://docs.docker.com/get-docker/
It is also recommended to install `docker-compose` as it can significantly ease the process: https://docs.docker.com/compose/install/
If you don't need the GUI, you can just install Docker Engine: https://docs.docker.com/engine/install/
## Building docker image
It is also recommended to install Docker Compose as it can significantly ease the process: https://docs.docker.com/compose/install/
* If you are using docker (not docker-compose) then run the following commands in this folder:
## Building Docker Image
* If you are using Docker (not Docker Compose) then run the following commands in this folder:
```shell
export \
QBT_VERSION=devel
@ -20,7 +22,7 @@ It is also recommended to install `docker-compose` as it can significantly ease
.
```
* If you are using docker-compose then you should edit `.env` file first.
* If you are using Docker Compose then you should edit `.env` file first.
You can find an explanation of the variables in the following [Parameters](#parameters) section. \
Then run the following commands in this folder:
```shell
@ -51,7 +53,7 @@ There are some paths involved:
## Running container
* Using docker (not docker-compose), simply run:
* Using Docker (not Docker Compose), simply run:
```shell
export \
QBT_EULA=accept \
@ -75,7 +77,7 @@ There are some paths involved:
qbittorrent-nox:"$QBT_VERSION"
```
* Using docker-compose:
* Using Docker Compose:
```shell
docker compose up
```
@ -84,12 +86,12 @@ Then you can login at: `http://127.0.0.1:8080`
## Stopping container
* Using docker (not docker-compose):
* Using Docker (not Docker Compose):
```shell
docker stop -t 1800 qbittorrent-nox
```
* Using docker-compose:
* Using Docker Compose:
```shell
docker compose down
```