kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
rodzic
8db6d8a0bf
commit
8b877849fd
|
@ -0,0 +1,126 @@
|
|||
# [linuxserver/embystat](https://github.com/linuxserver/docker-embystat)
|
||||
|
||||
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-embystat.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-embystat/releases)
|
||||
[![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")
|
||||
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/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)](https://hub.docker.com/r/linuxserver/embystat)
|
||||
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/embystat.svg?style=flat-square&color=E68523)](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.
|
||||
|
||||
## 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/).
|
||||
|
||||
Simply pulling `linuxserver/embystat` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
|
||||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=embystat \
|
||||
-e PUID=1000 \
|
||||
-e PGID=1000 \
|
||||
-e TZ=Europe/London \
|
||||
-p 6555:6555 \
|
||||
-v /path/to/appdata/config:/config \
|
||||
--restart unless-stopped \
|
||||
linuxserver/embystat
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
embystat:
|
||||
image: linuxserver/embystat
|
||||
container_name: embystat
|
||||
environment:
|
||||
- PUID=1000
|
||||
- PGID=1000
|
||||
- TZ=Europe/London
|
||||
volumes:
|
||||
- /path/to/appdata/config:/config
|
||||
ports:
|
||||
- 6555:6555
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## 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.
|
||||
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :----: | --- |
|
||||
| `6555` | web gui |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| `/config` | Contains all relevant configuration files. |
|
||||
|
||||
|
||||
|
||||
## 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`.
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
Access the webui at `<your-ip>:6555`. Follow the setup wizard on initial install. Then configure the required services.
|
||||
|
||||
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
* `docker exec -it embystat /bin/bash`
|
||||
* To monitor the logs of the container in realtime:
|
||||
* `docker logs -f embystat`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' embystat`
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/embystat`
|
||||
|
||||
## Versions
|
||||
|
||||
* **10.09.19:** - Initial Release.
|
Ładowanie…
Reference in New Issue