docker-documentation/images/docker-digikam.md

208 wiersze
10 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-18 12:53:01 +00:00
---
title: digikam
---
2021-04-22 13:05:40 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-digikam/blob/master/.github/CONTRIBUTING.md -->
2020-07-05 23:24:13 +00:00
# [linuxserver/digikam](https://github.com/linuxserver/docker-digikam)
2021-12-23 13:00:39 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Fdigikam?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdigikam)
2020-07-05 23:24:13 +00:00
[![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)
2020-12-16 22:48:37 +00:00
[![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)
2021-10-07 13:00:54 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/digikam)
2020-07-05 23:24:13 +00:00
[![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/)
2020-11-02 15:33:47 +00:00
[![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%2Fdigikam%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/digikam/latest/index.html)
2020-05-23 00:54:54 +00:00
[digiKam](https://www.digikam.org/): Professional Photo Management with the Power of Open Source
## Supported Architectures
2022-05-03 03:04:31 +00:00
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/).
2020-05-23 00:54:54 +00:00
2022-05-03 03:04:31 +00:00
Simply pulling `lscr.io/linuxserver/digikam:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2020-05-23 00:54:54 +00:00
The architectures supported by this image are:
2022-05-03 03:04:31 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
| armhf| ✅ | arm32v7-\<version tag\> |
2020-07-05 23:24:13 +00:00
2021-04-22 13:05:40 +00:00
## Application Setup
The application can be accessed at:
2022-02-21 03:48:57 +00:00
* http://yourhost:3000/
2021-04-22 13:05:40 +00:00
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:
2022-02-21 03:48:57 +00:00
* http://yourhost:3000/?login=true
You can also force login on the '/' path without this parameter by passing the environment variable `-e AUTO_LOGIN=false`.
#### Mysql Internal
When using mysql internal mode for the database you will need to click on "Find" Button for all the required binaries (mysql_install_db,mysqladmin,mysqld). Then select the binary file and press Open.
#### Keyboard Layouts
This should match the layout on the computer you are accessing the container from.
The keyboard layouts available for use are:
* da-dk-qwerty- Danish keyboard
* de-ch-qwertz- Swiss German keyboard (qwertz)
* de-de-qwertz- German keyboard (qwertz) - **OSK available**
* en-gb-qwerty- English (UK) keyboard
* en-us-qwerty- English (US) keyboard - **OSK available** **DEFAULT**
* es-es-qwerty- Spanish keyboard - **OSK available**
* fr-ch-qwertz- Swiss French keyboard (qwertz)
* fr-fr-azerty- French keyboard (azerty) - **OSK available**
* it-it-qwerty- Italian keyboard - **OSK available**
* ja-jp-qwerty- Japanese keyboard
* pt-br-qwerty- Portuguese Brazilian keyboard
* sv-se-qwerty- Swedish keyboard
* tr-tr-qwerty- Turkish-Q keyboard
2020-05-23 00:54:54 +00:00
## Usage
2021-07-08 13:00:09 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2020-05-23 00:54:54 +00:00
2021-07-08 13:00:09 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2020-05-23 00:54:54 +00:00
```yaml
---
version: "2.1"
services:
digikam:
2022-05-03 03:04:31 +00:00
image: lscr.io/linuxserver/digikam:latest
2020-05-23 00:54:54 +00:00
container_name: digikam
network_mode: host
environment:
- PUID=1000
- PGID=1000
- TZ=America/New_York
2022-02-21 03:48:57 +00:00
- SUBFOLDER=/ #optional
- KEYBOARD=en-us-qwerty #optional
2020-05-23 00:54:54 +00:00
volumes:
- /path/to/config:/config
ports:
- 3000:3000 #optional
restart: unless-stopped
```
2021-07-08 13:00:09 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-11-02 15:33:47 +00:00
2021-04-22 13:05:40 +00:00
```bash
2020-11-02 15:33:47 +00:00
docker run -d \
--name=digikam \
--net=host \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=America/New_York \
2022-02-21 03:48:57 +00:00
-e SUBFOLDER=/ `#optional` \
-e KEYBOARD=en-us-qwerty `#optional` \
2020-11-02 15:33:47 +00:00
-p 3000:3000 `#optional` \
-v /path/to/config:/config \
--restart unless-stopped \
2022-05-03 03:04:31 +00:00
lscr.io/linuxserver/digikam:latest
2020-11-02 15:33:47 +00:00
```
2020-05-23 00:54:54 +00:00
## Parameters
2020-07-05 23:24:13 +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.
2020-05-23 00:54:54 +00:00
2020-07-05 23:24:13 +00:00
### Ports (`-p`)
2020-05-23 00:54:54 +00:00
| Parameter | Function |
2020-07-05 23:24:13 +00:00
| :----: | --- |
2020-05-23 00:54:54 +00:00
| `3000` | digiKam desktop gui |
2020-07-05 23:24:13 +00:00
#### Networking (`--net`)
2021-04-22 13:05:40 +00:00
2020-05-23 00:54:54 +00:00
| Parameter | Function |
2020-07-05 23:24:13 +00:00
| :-----: | --- |
2020-05-23 00:54:54 +00:00
| `--net=host` | Use Host Networking |
2020-07-05 23:24:13 +00:00
### Environment Variables (`-e`)
2020-05-23 00:54:54 +00:00
| Env | Function |
2020-07-05 23:24:13 +00:00
| :----: | --- |
2020-05-23 00:54:54 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2020-07-05 23:24:13 +00:00
| `TZ=America/New_York` | Specify a timezone to use EG America/New_York. |
2022-02-21 03:48:57 +00:00
| `SUBFOLDER=/` | Specify a subfolder to use with reverse proxies, IE `/subfolder/` |
| `KEYBOARD=en-us-qwerty` | See the keyboard layouts section for more information and options. |
2020-05-23 00:54:54 +00:00
2020-07-05 23:24:13 +00:00
### Volume Mappings (`-v`)
2020-05-23 00:54:54 +00:00
| Volume | Function |
2020-07-05 23:24:13 +00:00
| :----: | --- |
2020-05-23 00:54:54 +00:00
| `/config` | Users home directory in the container, stores database. |
2021-10-07 13:00:54 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-05 23:24:13 +00:00
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-22 13:05:40 +00:00
```bash
2020-07-05 23:24:13 +00:00
-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.
2020-05-23 00:54:54 +00:00
## User / Group Identifiers
2020-07-05 23:24:13 +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`.
2020-05-23 00:54:54 +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:
2021-04-22 13:05:40 +00:00
```bash
2020-05-23 00:54:54 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Docker Mods
2021-04-22 13:05:40 +00:00
2020-11-02 15:33:47 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=digikam&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 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.")
2020-05-23 00:54:54 +00:00
2020-11-02 15:33:47 +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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-05-23 00:54:54 +00:00
## Support Info
* Shell access whilst the container is running:
* `docker exec -it digikam /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f digikam`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' digikam`
* Image version number
2022-05-03 03:04:31 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/digikam:latest`
2020-05-23 00:54:54 +00:00
## Versions
2022-11-21 18:07:42 +00:00
* **21.11.22:** - Trigger upon baseimage updates (arch being a rolling distro has too many dependency breaks otherwise). Release version will be the baseimage build date going forward.
2022-10-20 19:21:50 +00:00
* **20.10.22:** - Migrate to s6v3.
2022-03-07 21:12:49 +00:00
* **07.03.22:** - Add Exiftool and firefox for image exports.
2022-02-21 03:48:57 +00:00
* **20.02.22:** - Add MariaDB, expand documentation.
2022-02-16 13:21:28 +00:00
* **15.02.22:** - Rebase to Arch.
2021-12-27 22:43:59 +00:00
* **27.12.21:** - Rebase to focal to resolve dependency issues.
2021-03-27 19:17:39 +00:00
* **27.03.21:** - Download link fixed.
2021-12-27 22:43:59 +00:00
* **20.05.20:** - Initial release.