# Grocy •

[Grocy](https://grocy.info) is a household inventory and chore management solution for your family. Build a recipe book and use it to quickly build shopping lists. Construct a meal plan and always know what's for dinner next.

# Overview

[![Screen Shot 2025-03-07 at 17.28.42.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-28-42.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-28-42.png)

[Grocy](https://grocy.info) is a household inventory and chore management solution for your family. Build a recipe book and use it to quickly build shopping lists. Construct a meal plan and always know what's for dinner next.

<p class="callout success">Tryout an [Grocy demo](https://en.demo.grocy.info/stockoverview).</p>

- Build a comprehensive inventory of your kitchen and always know what's in stock.
- Quickly scan barcodes to add and remove items from your inventory.
- Keep track of your family's recurring chores and one-time tasks in one place.

# Media

## Screenshots

<p class="callout info">Grocy v4.4.2</p>

<table border="1" id="bkmrk-" style="border-collapse: collapse; width: 100%; border-width: 1px; height: 59.6px; border-color: rgb(88, 110, 117);"><colgroup><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col><col style="width: 33.3333%;"></col></colgroup><tbody><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.28.42.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-28-42.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-28-42.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.28.49.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-28-49.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-28-49.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.28.55.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-28-55.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-28-55.png)</td></tr><tr style="height: 29.8px;"><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.02.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-02.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-02.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.07.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-07.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-07.png)</td><td style="border-width: 1px; height: 29.8px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.12.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-12.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-12.png)</td></tr><tr><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.18.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-18.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-18.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.22.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-22.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-22.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.27.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-27.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-27.png)</td></tr><tr><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.29.45.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-29-45.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-29-45.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.30.40.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-30-40.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-30-40.png)</td><td style="border-width: 1px; border-color: rgb(88, 110, 117);">[![Screen Shot 2025-03-07 at 17.36.29.png](https://hub.subspace.services/uploads/images/gallery/2025-03/scaled-1680-/screen-shot-2025-03-07-at-17-36-29.png)](https://hub.subspace.services/uploads/images/gallery/2025-03/screen-shot-2025-03-07-at-17-36-29.png)</td></tr></tbody></table>

# Setup & Configuration

We need to install the service through Portainer and configure any necessary settings.

# Preparation

There are some things we need to do in preparation to install this service.

## Volumes

<details id="bkmrk-media-folders-radarr"><summary>Persistent Data</summary>

This is where the service will store its own application data and ensures we can quickly update the service image.

<p class="callout warning">Ensure your user has permissions to access the folder.</p>

</details>## Environment

<details id="bkmrk-tz-this-is-the-curre"><summary>TZ</summary>

This is the current time zone formatted using the [tz database.](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)

<p class="callout info">*For example:* America/Vancouver</p>

</details><details id="bkmrk-gid-%C2%A0"><summary>PUID</summary>

This is the numeric ID of the user account on Debian. If you are unsure, open a terminal and run:

```bash
id -u
```

</details><details id="bkmrk-pgid-this-is-the-num"><summary>PGID</summary>

This is the numeric ID of the user account's group on Debian. If you are unsure, open a terminal and run:

```bash
id -g
```

</details>

# Installation

The service can be installed through the Portainer web interface.

<p class="callout info">Learn about [creating a new stack](https://hub.subspace.services/books/portainer/page/creating-a-new-stack "Creating a New Stack").</p>

## Docker Compose

Use the following code to install the service:

```yaml
---
services:
  grocy:
    image: linuxserver/grocy:latest
    container_name: grocy
    network_mode: bridge
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/Vancouver
    volumes:
      # Persistent Data
      - /srv/grocy:/config
    ports:
      - 8181:80
    restart: unless-stopped
```

# Updating

<p class="callout warning">Backup and Re-Deploy the Stack</p>

This service has been partially optimized for running in Docker. This allows you to [re-deploy the stack through Portainer](https://hub.subspace.services/books/portainer/page/updating-a-stack "Updating a Stack") to download the latest updates.

During major updates, there may be new required settings within their configuration file. This will require an additional process detailed [within their documentation](https://github.com/grocy/grocy?tab=readme-ov-file#how-to-update) to add the missing settings.

# User Manual

# Development

<p class="callout info">This software is released under the [MIT license](https://opensource.org/license/mit). </p>

You can learn more about how to contribute to Grocy through their [documentation](https://github.com/grocy/grocy?tab=readme-ov-file#questions--help--bug-reports--feature-requests).

The developer also accepts [donations](https://grocy.info/#say-thanks).

# Resources

## Official

- [Official Discord](https://discord.gg/8JfAXSgfRf)
- [Official GitHub Repository](https://github.com/grocy/grocy)
- [Official Website](https://grocy.info)
- [Installation Guide](https://github.com/grocy/grocy#how-to-install)

## LinuxServer.io

- [Docker Image](https://docs.linuxserver.io/images/docker-grocy/)
- [Official Website](https://www.linuxserver.io/)
- [Official Documentation](https://docs.linuxserver.io/)
- [Official Discord](https://linuxserver.io/discord)
- [Official Forum](https://discourse.linuxserver.io/)
- [Official GitLab Repository ](https://gitlab.com/Linuxserver.io)
- [Frequently Asked Questions](https://docs.linuxserver.io/FAQ/)