From a8cae16e63a791a9112c612be669a3c57db80a97 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 22 Jun 2021 16:54:34 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-babybuddy.md | 135 +++++++++++++++++++++++++++++++++++++ 1 file changed, 135 insertions(+) create mode 100755 images/docker-babybuddy.md diff --git a/images/docker-babybuddy.md b/images/docker-babybuddy.md new file mode 100755 index 000000000..697e8e92a --- /dev/null +++ b/images/docker-babybuddy.md @@ -0,0 +1,135 @@ +--- +title: babybuddy +--- + + + +# [linuxserver/babybuddy](https://github.com/linuxserver/docker-babybuddy) + +[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-babybuddy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-babybuddy) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-babybuddy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-babybuddy/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-babybuddy/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-babybuddy/container_registry) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/babybuddy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/babybuddy "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/babybuddy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/babybuddy) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/babybuddy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/babybuddy) +[![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-babybuddy%2Fjob%2Fmain%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-babybuddy/job/main/) +[![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%2Fbabybuddy%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/babybuddy/latest/index.html) + +[Babybuddy](https://github.com/babybuddy/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](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/). + +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 `: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](https://github.com/babybuddy/babybuddy#configuration). + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) + +Compatible with docker-compose v2 schemas. + +```yaml +--- +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 + +```bash +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 `:` 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: + +```bash +-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. + +## Docker Mods + +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=babybuddy&query=%24.mods%5B%27babybuddy%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=babybuddy "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.") + +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. + +## 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 + +* **22.06.21:** - Initial release.