2021-02-17 20:17:16 +00:00
---
title: grocy
---
2020-07-04 20:24:09 +00:00
# [linuxserver/grocy](https://github.com/linuxserver/docker-grocy)
[](https://github.com/linuxserver/docker-grocy)
[](https://github.com/linuxserver/docker-grocy/releases)
[](https://github.com/linuxserver/docker-grocy/packages)
2020-12-16 14:22:49 +00:00
[](https://gitlab.com/linuxserver.io/docker-grocy/container_registry)
2020-07-04 20:24:09 +00:00
[](https://microbadger.com/images/linuxserver/grocy "Get your own version badge on microbadger.com")
[](https://hub.docker.com/r/linuxserver/grocy)
[](https://hub.docker.com/r/linuxserver/grocy)
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-grocy/job/master/)
2020-11-02 15:06:01 +00:00
[](https://ci-tests.linuxserver.io/linuxserver/grocy/latest/index.html)
2019-02-09 21:24:20 +00:00
2021-01-24 20:11:55 +00:00
[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.
2019-02-09 21:24:20 +00:00
2021-01-24 20:11:55 +00:00
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
2019-02-09 21:24:20 +00:00
2020-07-04 20:24:09 +00:00
For more information on grocy visit their website and check it out: https://grocy.info
2019-02-09 21:24:20 +00:00
## Supported Architectures
2019-08-31 20:23:55 +00:00
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/ ).
2019-02-09 21:24:20 +00:00
2020-11-02 15:06:01 +00:00
Simply pulling `ghcr.io/linuxserver/grocy` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-09 21:24:20 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-07-04 20:24:09 +00:00
| :----: | --- |
2019-02-09 21:24:20 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 20:23:15 +00:00
| armhf | arm32v7-latest |
2019-02-09 21:24:20 +00:00
2020-07-04 20:24:09 +00:00
2019-02-09 21:24:20 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
2020-10-03 20:23:53 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-09 21:24:20 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-11 20:23:59 +00:00
version: "2.1"
2019-02-09 21:24:20 +00:00
services:
grocy:
2020-11-02 15:06:01 +00:00
image: ghcr.io/linuxserver/grocy
2019-02-09 21:24:20 +00:00
container_name: grocy
environment:
2019-03-02 21:23:44 +00:00
- PUID=1000
- PGID=1000
2019-02-09 21:24:20 +00:00
- TZ=< your timezone , eg Europe / London >
volumes:
- < path to data > :/config
ports:
- 9283:80
restart: unless-stopped
```
2020-10-03 20:23:53 +00:00
### docker cli
```
docker run -d \
--name=grocy \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=< your timezone , eg Europe / London > \
-p 9283:80 \
-v < path to data > :/config \
--restart unless-stopped \
2020-11-02 15:06:01 +00:00
ghcr.io/linuxserver/grocy
2020-10-03 20:23:53 +00:00
```
2019-02-09 21:24:20 +00:00
## Parameters
2020-07-04 20:24:09 +00:00
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.
2019-02-09 21:24:20 +00:00
2020-07-04 20:24:09 +00:00
### Ports (`-p`)
2019-02-09 21:24:20 +00:00
| Parameter | Function |
2020-07-04 20:24:09 +00:00
| :----: | --- |
2019-02-09 21:24:20 +00:00
| `80` | will map the container's port 80 to port 9283 on the host |
2020-07-04 20:24:09 +00:00
### Environment Variables (`-e`)
2019-02-09 21:24:20 +00:00
| Env | Function |
2020-07-04 20:24:09 +00:00
| :----: | --- |
2019-03-02 21:23:44 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-09 21:24:20 +00:00
| `TZ=<your timezone, eg Europe/London>` | for specifying your timezone |
2020-07-04 20:24:09 +00:00
### Volume Mappings (`-v`)
2019-02-09 21:24:20 +00:00
| Volume | Function |
2020-07-04 20:24:09 +00:00
| :----: | --- |
2019-02-09 21:24:20 +00:00
| `/config` | this will store any uploaded data on the docker host |
2020-07-04 20:24:09 +00:00
## Environment variables from files (Docker secrets)
2020-05-30 20:23:58 +00:00
You can set any environment variable from a file by using a special prepend `FILE__` .
As an example:
2020-07-04 20:24:09 +00:00
```
2020-05-30 20:23:58 +00:00
-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
2020-07-04 20:24:09 +00:00
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.
2020-05-02 20:24:11 +00:00
2019-02-09 21:24:20 +00:00
## User / Group Identifiers
2020-07-04 20:24:09 +00:00
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` .
2019-02-09 21:24:20 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-02 21:23:44 +00:00
In this instance `PUID=1000` and `PGID=1000` , to find yours use `id user` as below:
2019-02-09 21:24:20 +00:00
2020-07-04 20:24:09 +00:00
```
2019-02-09 21:24:20 +00:00
$ id username
2019-03-02 21:23:44 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-09 21:24:20 +00:00
```
## Application Setup
2020-07-04 20:24:09 +00:00
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
2019-10-05 11:30:53 +00:00
2020-04-11 20:23:59 +00:00
## Docker Mods
2020-10-03 20:23:53 +00:00
[](https://mods.linuxserver.io/?mod=grocy "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-11 20:23:59 +00:00
2020-10-03 20:23:53 +00:00
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.
2020-04-11 20:23:59 +00:00
2019-02-09 21:24:20 +00:00
## Support Info
2019-08-31 20:23:55 +00:00
* Shell access whilst the container is running:
2019-02-09 21:24:20 +00:00
* `docker exec -it grocy /bin/bash`
2019-08-31 20:23:55 +00:00
* To monitor the logs of the container in realtime:
2019-02-09 21:24:20 +00:00
* `docker logs -f grocy`
2019-08-31 20:23:55 +00:00
* Container version number
2019-02-09 21:24:20 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' grocy`
* Image version number
2020-11-02 15:06:01 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/grocy`
2019-02-09 21:24:20 +00:00
## Versions
2021-02-17 20:17:16 +00:00
* **17.02.21:** - Rebasing to alpine 3.13.
2021-01-26 14:50:46 +00:00
* **26.01.21:** - Add 'ldap' PHP extension.
2020-12-22 14:02:42 +00:00
* **22.12.20:** - Add 'ctype' PHP extension.
2020-07-17 17:20:27 +00:00
* **01.06.20:** - Rebasing to alpine 3.12.
2019-12-20 21:06:58 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-09-22 15:41:08 +00:00
* **22.09.19:** - Add 'gd' PHP extension.
2019-06-30 19:43:39 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 20:23:15 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 16:32:19 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-09 21:24:20 +00:00
* **27.12.18:** - Initial Release.
