docker-documentation/images/docker-babybuddy.md

7.4 KiB
Executable File

title
babybuddy

linuxserver/babybuddy

GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Docker Pulls Docker Stars Jenkins Build LSIO CI

Babybuddy is a buddy for babies! Helps caregivers track sleep, feedings, diaper changes, tummy time and more to learn about and predict baby's needs without (as much) guess work.

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 and our announcement here.

Simply pulling ghcr.io/linuxserver/babybuddy 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
arm64 arm64v8-latest
armhf arm32v7-latest

Application Setup

Access the webui at <your-ip>:8000 (or whichever host port is mapped in docker arguments). The default user/pass are admin:admin.

By default BabyBuddy uses sqlite3. To use an external database like postgresql or mysql/mariadb instead, you can use the environment variables listed in BabyBuddy docs.

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:
  babybuddy:
    image: ghcr.io/linuxserver/babybuddy
    container_name: babybuddy
    environment:
      - TZ=Europe/London
    volumes:
      - /path/to/appdata:/config
    ports:
      - 8000:8000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=babybuddy \
  -e TZ=Europe/London \
  -p 8000:8000 \
  -v /path/to/appdata:/config \
  --restart unless-stopped \
  ghcr.io/linuxserver/babybuddy

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
8000 the port for the web ui

Environment Variables (-e)

Env Function
TZ=Europe/London Specify a timezone to use EG Europe/London

Volume Mappings (-v)

Volume Function
/config Contains all relevant configuration and data.

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.

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 babybuddy /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f babybuddy
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' babybuddy
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/babybuddy

Versions

  • 25.07.21: - Add libpq for postgresql.
  • 08.07.21: - Fix pip install issue.
  • 05.07.21: - Update Gunicorn parameters to prevent WORKER_TIMEOUT issue.
  • 22.06.21: - Initial release.