From 56c898c0ab7f9ff02c6bf0a6ce9f9bef8c4e5df8 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 22 Apr 2021 07:54:44 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-grocy.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/images/docker-grocy.md b/images/docker-grocy.md index fccadce82..47a377843 100644 --- a/images/docker-grocy.md +++ b/images/docker-grocy.md @@ -1,6 +1,9 @@ --- title: grocy --- + + + # [linuxserver/grocy](https://github.com/linuxserver/docker-grocy) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-grocy.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-grocy) @@ -19,7 +22,6 @@ Keep track of your purchases, how much food you are wasting, what chores need do For more information on grocy visit their website and check it out: https://grocy.info - ## 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/). @@ -34,6 +36,10 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +Grocy is simple to get running. Configure the container with the above instructions, start it, and you can then access it +by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin ## Usage @@ -63,7 +69,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=grocy \ -e PUID=1000 \ @@ -75,7 +81,6 @@ docker run -d \ ghcr.io/linuxserver/grocy ``` - ## 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. @@ -86,7 +91,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `80` | will map the container's port 80 to port 9283 on the host | - ### Environment Variables (`-e`) | Env | Function | @@ -101,15 +105,13 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `/config` | this will store any uploaded data on the docker host | - - ## 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 ``` @@ -120,7 +122,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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`. @@ -129,23 +130,17 @@ Ensure any volume directories on the host are owned by the same user you specify In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -``` +```bash $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` -## Application Setup - -Grocy is simple to get running. Configure the container with the above instructions, start it, and you can then access it -by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin - - ## Docker Mods + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=grocy&query=%24.mods%5B%27grocy%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=grocy "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: