# Grocy Docker # Instalação e Configuração Grocy Docker Procedimentos de instalação e configuração Grocy em Docker. # Instalação Grocy Docker Link: [https://docs.linuxserver.io/images/docker-grocy/](https://docs.linuxserver.io/images/docker-grocy/) Customizações especiais não oficiais: **1)** Feito mapeamento do arquivo de tradução do português brasileiro (strings.po) dentro do "docker-compose.yml" com a seguinte entrada: **./volumes/custom/strings.po:/app/www/localization/pt\_BR/strings.po:rw** No /opt/docker/grocy : **vim volumes/custom/strings.po** **2)** Configurações de layout, de parâmetros especiais e para supressão de módulos do Grocy: **vim volumes/config/data/config.php** ### [linuxserver/grocy](https://github.com/linuxserver/docker-grocy) [Grocy](https://github.com/grocy/grocy) is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility. Keep track of your purchases, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool For more information on grocy visit their website and check it out: https://grocy.info [![grocy](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/grocy-logo.png)](https://github.com/grocy/grocy) ## Supported Architectures[¶](https://docs.linuxserver.io/images/docker-grocy/#supported-architectures "Permanent link") We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). Simply pulling `lscr.io/linuxserver/grocy: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:
ArchitectureAvailableTag
x86-64✅amd64-<version tag>
arm64✅arm64v8-<version tag>
armhf❌
## Application Setup Grocy is simple to get running. Configure the container with instructions below, 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 ### Upgrading Following a container upgrade ensure that you visit the root (`/`) route (click on the logo in the left upper edge) in order to run any necessary database migrations. See [https://github.com/grocy/grocy#how-to-update](https://github.com/grocy/grocy#how-to-update) for more details. ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. Info Unless a parameter is flaged as 'optional', it is *mandatory* and a value must be provided. #### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose)) ``` ``` --- services: grocy: image: lscr.io/linuxserver/grocy:latest container_name: grocy environment: - PUID=1000 - PGID=1000 - TZ=Etc/UTC volumes: - /path/to/grocy/config:/config ports: - 9283:80 restart: unless-stopped ``` ``` #### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/)) ``` ``` docker run -d \ --name=grocy \ -e PUID=1000 \ -e PGID=1000 \ -e TZ=Etc/UTC \ -p 9283:80 \ -v /path/to/grocy/config:/config \ --restart unless-stopped \ lscr.io/linuxserver/grocy:latest ``` ``` ## Parameters Containers 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`)
ParameterFunction
`9283:80`will map the container's port 80 to port 9283 on the host
### Environment Variables (`-e`)
EnvFunction
`PUID=1000`for UserID - see below for explanation
`PGID=1000`for GroupID - see below for explanation
`TZ=Etc/UTC`specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).
### Volume Mappings (`-v`)
VolumeFunction
`/config`Persistent config files
#### Miscellaneous Options
ParameterFunction
### 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__MYVAR=/run/secrets/mysecretvariable ``` ``` Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` 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. ## 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 your_user` as below: ``` ``` id your_user ``` ``` Example output: ``` ``` uid=1000(your_user) gid=1000(your_user) groups=1000(your_user) ``` ``` ## 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: ``` ``` docker exec -it grocy /bin/bash ``` ``` - To monitor the logs of the container in realtime: ``` ``` docker logs -f grocy ``` ``` - Container version number: ``` ``` docker inspect -f '{{ index .Config.Labels "build_version" }}' grocy ``` ``` - Image version number: ``` ``` docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/grocy:latest ``` ``` ## Updating Info Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](https://docs.linuxserver.io/images/docker-grocy/#application-setup) section above to see if it is recommended for the image. Below are the instructions for updating containers: ### Via Docker Compose - Update images: - All images: ``` ``` docker-compose pull ``` ``` - Single image: ``` ``` docker-compose pull grocy ``` ``` - Update containers: - All containers: ``` ``` docker-compose up -d ``` ``` - Single container: ``` ``` docker-compose up -d grocy ``` ``` - You can also remove the old dangling images: ``` ``` docker image prune ``` ``` ### Via Docker Run - Update the image: ``` ``` docker pull lscr.io/linuxserver/grocy:latest ``` ``` - Stop the running container: ``` ``` docker stop grocy ``` ``` - Delete the container: ``` ``` docker rm grocy ``` ``` - Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved) - You can also remove the old dangling images: ``` ``` docker image prune ``` ``` ### Image Update Notifications - Diun (Docker Image Update Notifier) Tip We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported. ## Building locally If you want to make local modifications to these images for development purposes or just to customize the logic: ``` ``` git clone https://github.com/linuxserver/docker-grocy.git cd docker-grocy docker build \ --no-cache \ --pull \ -t lscr.io/linuxserver/grocy:latest . ``` ``` The ARM variants can be built on x86\_64 hardware and vice versa using `lscr.io/linuxserver/qemu-static` ``` ``` docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset ``` ``` Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. To help with development, we generate this dependency graph.
Init dependency graph
## Versions - **30.06.24:** - Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings. - **29.03.24:** - Add `clear_env = no` to `php-fpm` to pass on environment variables to workers threads - **06.03.24:** - Existing users should update: site-confs/default.conf - Cleanup default site conf. - **06.03.24:** - Rebase to Alpine 3.19 with php 8.3. - **25.05.23:** - Rebase to Alpine 3.18, deprecate armhf. - **13.04.23:** - Move ssl.conf include to default.conf. - **19.01.23:** - Rebase to alpine 3.17 with php8.1. - **20.08.22:** - Rebasing to alpine 3.15 with php8. Restructure nginx configs ([see changes announcement](https://info.linuxserver.io/issues/2022-08-20-nginx-base)). - **22.08.21:** - Rebase to Alpine 3.14 and PHP 8. - **25.07.21:** - Add 'int','json' and 'zlib' PHP extensions. - **10.05.21:** - Reduce image size. - **08.04.21:** - Update docs to reflect jenkins builder changes. - **17.02.21:** - Rebasing to alpine 3.13. - **26.01.21:** - Add 'ldap' PHP extension. - **22.12.20:** - Add 'ctype' PHP extension. - **01.06.20:** - Rebasing to alpine 3.12. - **19.12.19:** - Rebasing to alpine 3.11. - **22.09.19:** - Add 'gd' PHP extension. - **28.06.19:** - Rebasing to alpine 3.10. - **23.03.19:** - Switching to new Base images, shift to arm32v7 tag. - **22.02.19:** - Rebasing to alpine 3.9. - **27.12.18:** - Initial Release. January 31, 2025 ebruary 6, 2019 # Desabilitando ou excluindo botões no Grocy Link: [https://www.reddit.com/r/grocy/comments/1987cf1/how\_to\_remove\_consume\_all\_button/](https://www.reddit.com/r/grocy/comments/1987cf1/how_to_remove_consume_all_button/) Grocy Developer It's kind of impossible to have a configuration option for each and every single detail, unless having a trillion of them at the end. A very practically oriented advice of mine (I know, always unpopular here): Just don't click that button if it doesn't make sense. And if it happened accidentally, it's even just one more click to undo the corresponding transaction. If that's not the way to go for you, custom JS gives you the opportunity to customize everything to your very end without having to maintain a complete own fork or something like that. So imagine you've added a Userfield named "disableconsumeall" to the entity "products" (demo), this snippet (for data/custom\_js.html) would disable the "consume all button" on the stock overview page when this Userfield is set for the corresponding product: **<script>** **if (Grocy.View == "stockoverview")** **{** **$("\[id$=consume-all-button\]").each(function()** **{** **var button = $(this);** **Grocy.Api.Get("objects/products/" + button.attr("data-product-id"),** **function(product)** **{** **if (product.userfields.disableconsumeall == 1)** **{** **button.addClass("disabled");** **}** **}** **);** **});** **}** **</script>** 1y ago Awesome! Thank you. I am going to work on this. I'm with you on the just don't click the button. Lol. I am implementing this for the entire house. Trying my best to make sure that every option that is available is actually used. Make it as clutter-free as possible. Next step is to get a laser barcode going with some kind of tablet/PC in the basement to check things in/out. 1y ago Well, I'm struggling to get this to work. I did do the 2 steps mentioned: I did add the Userfield exactly as described. I did create data/custom\_js.html which is exactly: <html> <head></head> <body> <script> if (Grocy.View == "stockoverview") { $("\[id$=consume-all-button\]").each(function() { var button = $(this); Grocy.Api.Get("objects/products/" + button.attr("data-product-id"), function(product) { if (product.userfields.disableconsumeall == 1) { button.addClass("disabled"); } } ); }); } </script> </body> </html> Any ideas on what I could be missing? The custom\_js.html didn't exist, so I created it myself. I am running this in Docker on unRAID. Have restarted the container several times. Thank you. Grocy Developer Simply compare my posted snippet above with what you've put into the mentioned file again. Especially "<html><head></head><body>" at the beginning and "</body></html>" at the end - that wasn't part of my posted snippet, make sure exactly only the snippet is in the file, nothing more or less. Okay. I am still struggling. I did try the code exactly how you gave the first time, no luck. The reason I put in the other tags, was because I saw this on the github page: Adding your own CSS or JS without to have to modify the application itself When the file data/custom\_js.html exists, the contents of the file will be added just before </body> (end of body) on every page When the file data/custom\_css.html exists, the contents of the file will be added just before </head> (end of head) on every page I'll do some more work on my side to see what the deal is. It seems like this should be super easy, so I'm sure it's something with me. Awesome software btw. 1y ago Grocy Developer There is stated that those snippets will be included in the HTML markup of the page at the mentioned places. When you introduce a whole other HTML document there, of course the whole page is kind of broken then. Not interpreting that much into something, reading twice and just doing exactly what is mentioned is the key most of the time I guess... 1y ago You know what, I'm dumb. This actually did work. I did not realize that once you complete these steps, you must go into and edit the product itself and check "disable consume all" This is awesome. It does only just disable the "Consume All" button but does not hide it. Grocy Developer It does only just disable the "Consume All" button but does not hide it. **Replace button.addClass("disabled"); by button.remove();** and also that will be reality right now.