Bot Updating Documentation

pull/37/head
LinuxServer-CI 2021-04-17 03:46:55 +01:00
rodzic a8a2d1bc51
commit 5b0aa79b34
1 zmienionych plików z 17 dodań i 21 usunięć

Wyświetl plik

@ -1,6 +1,9 @@
--- ---
title: pyload title: pyload
--- ---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-pyload/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/pyload](https://github.com/linuxserver/docker-pyload) # [linuxserver/pyload](https://github.com/linuxserver/docker-pyload)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-pyload.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-pyload) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-pyload.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-pyload)
@ -14,7 +17,6 @@ title: pyload
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fpyload%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/pyload/latest/index.html) [![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fpyload%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/pyload/latest/index.html)
[Pyload](https://pyload.net/) is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web. [Pyload](https://pyload.net/) is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
## Supported Architectures ## Supported Architectures
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
@ -38,6 +40,16 @@ This image provides various versions that are available via tags. `latest` tag u
| latest | Stable releases from Pyload | | latest | Stable releases from Pyload |
| ng | Development releases from Pyload-ng (currently alpha) | | ng | Development releases from Pyload-ng (currently alpha) |
## Application Setup
Access the web interface at `http://your-ip:8000` the default login is:
username - **admin**
password - **password**
For the `ng` tag, the default user/pass are `pyload/pyload`.
For general usage please see the pyLoad wiki [here](https://github.com/pyload/pyload/wiki) .
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
@ -68,7 +80,7 @@ services:
### docker cli ### docker cli
``` ```bash
docker run -d \ docker run -d \
--name=pyload \ --name=pyload \
-e PUID=1000 \ -e PUID=1000 \
@ -82,7 +94,6 @@ docker run -d \
ghcr.io/linuxserver/pyload ghcr.io/linuxserver/pyload
``` ```
## Parameters ## Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container. Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
@ -94,7 +105,6 @@ Docker images are configured using parameters passed at runtime (such as those a
| `8000` | Allows HTTP access to the application | | `8000` | Allows HTTP access to the application |
| `7227` | pyLoad control port | | `7227` | pyLoad control port |
### Environment Variables (`-e`) ### Environment Variables (`-e`)
| Env | Function | | Env | Function |
@ -110,15 +120,13 @@ Docker images are configured using parameters passed at runtime (such as those a
| `/config` | pyLoad Configuration and files database | | `/config` | pyLoad Configuration and files database |
| `/downloads` | Destination of pyLoad downloads | | `/downloads` | Destination of pyLoad downloads |
## Environment variables from files (Docker secrets) ## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`. You can set any environment variable from a file by using a special prepend `FILE__`.
As an example: As an example:
``` ```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword -e FILE__PASSWORD=/run/secrets/mysecretpassword
``` ```
@ -129,7 +137,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers ## User / Group Identifiers
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`. When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
@ -138,28 +145,17 @@ Ensure any volume directories on the host are owned by the same user you specify
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
``` ```bash
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup
Access the web interface at `http://your-ip:8000` the default login is:
username - **admin**
password - **password**
For the `ng` tag, the default user/pass are `pyload/pyload`.
For general usage please see the pyLoad wiki [here](https://github.com/pyload/pyload/wiki) .
## Docker Mods ## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pyload&query=%24.mods%5B%27pyload%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=pyload "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pyload&query=%24.mods%5B%27pyload%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=pyload "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info ## Support Info
* Shell access whilst the container is running: * Shell access whilst the container is running: