docker-documentation/images/docker-digikam.md

10 KiB

title
digikam

linuxserver/digikam

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

digiKam: Professional Photo Management with the Power of Open Source

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

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.

The architectures supported by this image are:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf arm32v7-<version tag>

Application Setup

The application can be accessed at:

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:

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

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
version: "2.1"
services:
  digikam:
    image: lscr.io/linuxserver/digikam:latest
    container_name: digikam
    network_mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
      - SUBFOLDER=/ #optional
      - KEYBOARD=en-us-qwerty #optional
    volumes:
      - /path/to/config:/config
    ports:
      - 3000:3000 #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=digikam \
  --net=host \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=America/New_York \
  -e SUBFOLDER=/ `#optional` \
  -e KEYBOARD=en-us-qwerty `#optional` \
  -p 3000:3000 `#optional` \
  -v /path/to/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/digikam:latest

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
3000 digiKam desktop gui

Networking (--net)

Parameter Function
--net=host Use Host Networking

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.
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.

Volume Mappings (-v)

Volume Function
/config Users home directory in the container, stores database.

Miscellaneous Options

Parameter Function

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 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.

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)

Docker Mods

Docker Mods Docker Universal Mods

We publish various 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.

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
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/digikam:latest

Versions

  • 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.
  • 20.10.22: - Migrate to s6v3.
  • 07.03.22: - Add Exiftool and firefox for image exports.
  • 20.02.22: - Add MariaDB, expand documentation.
  • 15.02.22: - Rebase to Arch.
  • 27.12.21: - Rebase to focal to resolve dependency issues.
  • 27.03.21: - Download link fixed.
  • 20.05.20: - Initial release.