Bot Updating Documentation

pull/13/head
LinuxServer-CI 2020-05-19 17:57:22 +00:00
rodzic f99f7839ff
commit 08dd60a9eb
1 zmienionych plików z 33 dodań i 18 usunięć

Wyświetl plik

@ -1,8 +1,17 @@
# linuxserver/embystat # [linuxserver/embystat](https://github.com/linuxserver/docker-embystat)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-embystat.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-embystat.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-embystat/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/embystat) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/embystat.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/embystat) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/embystat.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/embystat) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/embystat.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/embystat) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-embystat/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-embystat/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/embystat/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/embystat/latest/index.html) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-embystat.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-embystat.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-embystat/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-embystat/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/embystat)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/embystat.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/embystat "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/embystat.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/embystat)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/embystat.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/embystat)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-embystat/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-embystat/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/embystat/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/embystat/latest/index.html)
[Embystat](https://github.com/mregni/EmbyStat) is a personal web server that can calculate all kinds of statistics from your \(local\) Emby server. Just install this on your server and let him calculate all kinds of fun stuff. [Embystat](https://github.com/mregni/EmbyStat) is a personal web server that can calculate all kinds of statistics from your (local) Emby server. Just install this on your server and let him calculate all kinds of fun stuff.
## Supported Architectures ## Supported Architectures
@ -13,18 +22,19 @@ Simply pulling `linuxserver/embystat` should retrieve the correct image for your
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## 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.
### docker ### docker
```text ```
docker create \ docker create \
--name=embystat \ --name=embystat \
-e PUID=1000 \ -e PUID=1000 \
@ -36,6 +46,7 @@ docker create \
linuxserver/embystat linuxserver/embystat
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -60,50 +71,55 @@ services:
## 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.
### Ports \(`-p`\) ### Ports (`-p`)
| Parameter | Function | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `6555` | web gui | | `6555` | web gui |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Contains all relevant configuration files. | | `/config` | Contains all relevant configuration files. |
## 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`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic. Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
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:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## Application Setup
Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install. Then configure the required services. Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install. Then configure the required services.
## Docker Mods ## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27embystat%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=embystat "view available mods for this container.")
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27embystat%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=embystat) 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) can be accessed via the dynamic badge 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\) can be accessed via the dynamic badge above.
## Support Info ## Support Info
@ -122,4 +138,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* **04.12.19:** - Disable in app updates. * **04.12.19:** - Disable in app updates.
* **12.11.19:** - Multi-arch builds. * **12.11.19:** - Multi-arch builds.
* **10.09.19:** - Initial Release. * **10.09.19:** - Initial Release.