From 937228e3ed0e6e4a2eed50f1b2cd8dc6a0300432 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Mon, 6 Jul 2020 01:24:13 +0200 Subject: [PATCH] Bot Updating Documentation --- images/docker-digikam.md | 76 +++++++++++++++++++++++++++------------- 1 file changed, 52 insertions(+), 24 deletions(-) diff --git a/images/docker-digikam.md b/images/docker-digikam.md index 5a77f9db6..b3deac2bd 100644 --- a/images/docker-digikam.md +++ b/images/docker-digikam.md @@ -1,6 +1,14 @@ -# linuxserver/digikam +# [linuxserver/digikam](https://github.com/linuxserver/docker-digikam) -[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-digikam.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-digikam) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-digikam.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-digikam/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-digikam/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-digikam/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/digikam) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/digikam.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/digikam) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/digikam.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/digikam) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/digikam.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/digikam) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-digikam/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-digikam/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/digikam/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/digikam/latest/index.html) +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-digikam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-digikam) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-digikam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-digikam/releases) +[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-digikam/packages) +[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-digikam/container_registry) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/digikam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/digikam "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/digikam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/digikam) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/digikam.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/digikam) +[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-digikam%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-digikam/job/master/) +[![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%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Fdigikam%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/digikam/latest/index.html) [digiKam](https://www.digikam.org/): Professional Photo Management with the Power of Open Source @@ -13,10 +21,9 @@ Simply pulling `linuxserver/digikam` should retrieve the correct image for your The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | latest | -| arm64 | arm64v8-latest | -| armhf | arm32v7-latest | + ## Usage @@ -24,7 +31,7 @@ Here are some example snippets to help you get started creating a container from ### docker -```text +``` docker create \ --name=digikam \ --net=host \ @@ -37,6 +44,7 @@ docker create \ linuxserver/digikam ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -63,43 +71,62 @@ services: ## Parameters -Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `:` 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 `:` 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 | -| :---: | :--- | +| :----: | --- | | `3000` | digiKam desktop gui | -#### Networking \(`--net`\) - +#### Networking (`--net`) | Parameter | Function | -| :---: | :--- | +| :-----: | --- | | `--net=host` | Use Host Networking | -### Environment Variables \(`-e`\) +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | -| `TZ=America/New_York` | Specify a timezone to use EG America/New\_York. | +| `TZ=America/New_York` | Specify a timezone to use EG America/New_York. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Users home directory in the container, stores database. | + + +## Environment variables from files (Docker secrets) + +You can set any environment variable from a file by using a special prepend `FILE__`. + +As an example: + +``` +-e FILE__PASSWORD=/run/secrets/mysecretpassword +``` + +Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file. + +## Umask for running applications + +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. + + ## 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. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -108,15 +135,17 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel The application can be accessed at: -[http://yourhost:3000/](http://yourhost:3000/) By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link: +http://yourhost:3000/ +By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link: + +http://yourhost:3000/?login=true -[http://yourhost:3000/?login=true](http://yourhost:3000/?login=true) ## Docker Mods +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27digikam%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=digikam "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%27digikam%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=digikam) +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 @@ -132,4 +161,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions * **20.05.20:** - Initial release. -