docker-documentation/images/docker-dillinger.md

139 wiersze
6.2 KiB
Markdown
Czysty Zwykły widok Historia

2020-05-04 16:37:55 +00:00
# [linuxserver/dillinger](https://github.com/linuxserver/docker-dillinger)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-dillinger.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-dillinger)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-dillinger.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-dillinger/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-dillinger/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-dillinger/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/dillinger)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/dillinger.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/dillinger "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/dillinger.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/dillinger)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/dillinger.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/dillinger)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-dillinger/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-dillinger/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/dillinger/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/dillinger/latest/index.html)
2019-06-05 20:25:59 +00:00
2020-04-28 15:23:37 +00:00
[Dillinger](https://github.com/joemccann/dillinger) is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
2019-09-30 16:38:45 +00:00
2020-05-04 16:37:55 +00:00
2019-06-05 20:25:59 +00:00
## Supported Architectures
2019-09-02 16:37:55 +00:00
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/).
2019-06-05 20:25:59 +00:00
Simply pulling `linuxserver/dillinger` 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 |
2020-05-04 16:37:55 +00:00
| :----: | --- |
2019-06-05 20:25:59 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
2020-05-04 16:37:55 +00:00
2019-06-05 20:25:59 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-05-04 16:37:55 +00:00
```
2019-06-05 20:25:59 +00:00
docker create \
--name=dillinger \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 8080:8080 \
-v <path to configs>:/config \
--restart unless-stopped \
linuxserver/dillinger
```
2020-05-04 16:37:55 +00:00
2019-06-05 20:25:59 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-13 16:37:58 +00:00
version: "2.1"
2019-06-05 20:25:59 +00:00
services:
dillinger:
image: linuxserver/dillinger
container_name: dillinger
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- <path to configs>:/config
ports:
- 8080:8080
restart: unless-stopped
```
## Parameters
2020-05-04 16:37:55 +00:00
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.
2019-06-05 20:25:59 +00:00
2020-05-04 16:37:55 +00:00
### Ports (`-p`)
2019-06-05 20:25:59 +00:00
| Parameter | Function |
2020-05-04 16:37:55 +00:00
| :----: | --- |
2019-06-05 20:25:59 +00:00
| `8080` | The port for the Dillinger web interface |
2020-05-04 16:37:55 +00:00
### Environment Variables (`-e`)
2019-06-05 20:25:59 +00:00
| Env | Function |
2020-05-04 16:37:55 +00:00
| :----: | --- |
2019-06-05 20:25:59 +00:00
| `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 |
2020-05-04 16:37:55 +00:00
### Volume Mappings (`-v`)
2019-06-05 20:25:59 +00:00
| Volume | Function |
2020-05-04 16:37:55 +00:00
| :----: | --- |
2019-06-05 20:25:59 +00:00
| `/config` | Dillinger plugin config files |
2020-05-04 16:37:55 +00:00
2019-06-05 20:25:59 +00:00
## User / Group Identifiers
2020-05-04 16:37:55 +00:00
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`.
2019-06-05 20:25:59 +00:00
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:
2020-05-04 16:37:55 +00:00
```
2019-06-05 20:25:59 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
2020-05-04 16:37:55 +00:00
Access the webui at http://your-ip:8080 , keep in mind that storage for this application is in your browser session not server side. Only plugin configurations will ever be stored server side.
2019-09-30 16:38:45 +00:00
2020-04-13 16:37:58 +00:00
## Docker Mods
2020-05-04 16:37:55 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27dillinger%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=dillinger "view available mods for this container.")
2020-04-13 16:37:58 +00:00
2020-05-04 16:37:55 +00:00
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.
2020-04-13 16:37:58 +00:00
2019-06-05 20:25:59 +00:00
## Support Info
2019-09-02 16:37:55 +00:00
* Shell access whilst the container is running:
2019-06-05 20:25:59 +00:00
* `docker exec -it dillinger /bin/bash`
2019-09-02 16:37:55 +00:00
* To monitor the logs of the container in realtime:
2019-06-05 20:25:59 +00:00
* `docker logs -f dillinger`
2019-09-02 16:37:55 +00:00
* Container version number
2019-06-05 20:25:59 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' dillinger`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/dillinger`
## Versions
* **31.05.19:** - Initial Release.