Skip to main content

Open-source alternatives guide

How to Self-Host Grocy 2026

Self-host Grocy in 2026. MIT license, ~7K stars, PHP — home inventory, stock management, shopping lists, barcode scanning, task scheduler, household chore.

·OSSAlt Team
Share:

TL;DR

Grocy (MIT, ~7K GitHub stars, PHP) is a self-hosted household management system. It tracks your pantry inventory (what food you have, what's expiring soon), manages shopping lists (auto-populated from what you're running low on), tracks household chores and tasks, and integrates with recipe managers. There's no commercial equivalent — Pantry Check and other apps are missing Grocy's depth. Scan barcodes with your phone to add items, get notifications before food expires, and never run out of things you need.

Key Takeaways

  • Grocy: MIT, ~7K stars, PHP — pantry inventory, shopping lists, chores, barcode scanning
  • Stock tracking: Know exactly what you have and when it expires
  • Shopping lists: Auto-add items that are below your minimum stock level
  • Barcode scanning: Grocy app scans barcodes to add/remove stock
  • Chore tracking: Schedule household tasks with recurrence and assignment
  • Recipe integration: Sync with Mealie via API — shopping list from meal plans

Part 1: Docker Setup

# docker-compose.yml
services:
  grocy:
    image: lscr.io/linuxserver/grocy:latest
    container_name: grocy
    restart: unless-stopped
    ports:
      - "9283:80"
    volumes:
      - grocy_config:/config
    environment:
      PUID: 1000
      PGID: 1000
      TZ: America/Los_Angeles
      # Grocy config (also configurable via UI):
      GROCY_CURRENCY: "USD"
      GROCY_CULTURE: "en"
      GROCY_DEFAULT_LOCALE: "en"
      GROCY_FEATURE_FLAG_STOCK: "true"
      GROCY_FEATURE_FLAG_SHOPPINGLIST: "true"
      GROCY_FEATURE_FLAG_RECIPES: "true"
      GROCY_FEATURE_FLAG_CHORES: "true"
      GROCY_FEATURE_FLAG_TASKS: "true"
      GROCY_FEATURE_FLAG_BATTERIES: "true"
      GROCY_FEATURE_FLAG_EQUIPMENT: "true"
      GROCY_FEATURE_FLAG_CALENDAR: "true"

volumes:
  grocy_config:
docker compose up -d

Visit http://your-server:9283 — default credentials are admin / admin (change immediately).


Part 2: HTTPS with Caddy

home.yourdomain.com {
    reverse_proxy localhost:9283
}

Part 3: Initial Configuration

  1. Settings → User settings: Change your password
  2. Settings → System settings:
    • Currency symbol and decimal places
    • Default due days for new products
    • Language and locale
  3. Master data → Locations: Add your storage locations:
    • Pantry, Refrigerator, Freezer, Cabinet, Garage
  4. Master data → Quantity units: Add your units:
    • piece, g, kg, ml, L, cup, tbsp, tsp

Part 4: Adding Products

Via web UI

  1. Products → Add product
  2. Name, barcode (optional), default quantity, location
  3. Min. stock amount: Alert when below this
  4. Default due days: How many days after purchase until it expires

Via barcode scanner (Grocy app)

  1. Install Grocy Android app
  2. Connect to your Grocy server
  3. Scanner: tap camera icon → scan barcode → Grocy looks up the product
  4. If not in database: add it first, then scan again

Via Barcode Buddy (auto-lookup)

# Add to docker-compose.yml — auto-looks up barcodes via Open Food Facts:
services:
  barcodebuddy:
    image: f0rc3/barcodebuddy-docker:latest
    container_name: barcodebuddy
    restart: unless-stopped
    ports:
      - "9090:80"
    volumes:
      - barcodebuddy_config:/config
    environment:
      BBUDDY_GROCY_API_URL: "http://grocy:80/api/"
      BBUDDY_GROCY_API_KEY: "${GROCY_API_KEY}"

Part 5: Stock Management

Add stock (purchase)

  1. Stock overview → [Product] → Purchase
  2. Amount, price, due date, location, store
  3. Or scan barcode in app → "Purchase"

Consume stock

  1. Stock overview → [Product] → Consume
  2. Amount consumed
  3. Or scan barcode in app → "Consume"

Stock overview

The main dashboard shows:

  • Due soon: Items expiring in the next 5 days
  • Overdue: Items past their due date
  • Below min. stock: Items you need to buy
  • Never opened: Sealed items

Part 6: Shopping Lists

Manual shopping list

  1. Shopping list → Add item
  2. Product + amount + where to buy

Auto-populate from stock

  1. Shopping list → + → Add missing products
  2. Grocy adds everything below minimum stock level
  3. Sort by location/store for efficient shopping

Check off while shopping

Use the Grocy mobile app:

  1. Open shopping list
  2. Check off items as you add them to your cart
  3. When done: Mark all as done → automatically added to your stock

Part 7: Chores

Track and schedule household chores:

  1. Chores → Add chore
  2. Name: Clean bathroom, Vacuum living room, Change furnace filter
  3. Period type: Daily, Weekly, Monthly, or specific interval
  4. Next estimated due date
  5. Assigned to: Which household member

Chore dashboard: See what's due today, overdue, and upcoming.

# Create a chore via API:
curl -X POST "${GROCY_URL}/api/objects/chores" \
  -H "GROCY-API-KEY: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Change AC filter", "period_type": "monthly", "period_days": 30}'

# Mark a chore as done:
curl -X POST "${GROCY_URL}/api/chores/1/execute" \
  -H "GROCY-API-KEY: $API_KEY" \
  -d '{"tracked_time": "2026-03-10 10:00:00", "done_by": 1}'

Part 8: API Integration

# Get Grocy API key:
# Settings → Manage API keys → + Create

GROCY_URL="https://home.yourdomain.com"
API_KEY="your-api-key"

# Get current stock:
curl "${GROCY_URL}/api/stock" \
  -H "GROCY-API-KEY: $API_KEY" | jq '.[] | select(.amount < .product.min_stock_amount) | .product.name'

# Get items expiring in next 5 days:
curl "${GROCY_URL}/api/stock/volatile?due_soon_days=5" \
  -H "GROCY-API-KEY: $API_KEY" | jq '.due_products[].product.name'

# Add to shopping list:
curl -X POST "${GROCY_URL}/api/stock/shoppinglist/add-missing-products" \
  -H "GROCY-API-KEY: $API_KEY"

# Get shopping list:
curl "${GROCY_URL}/api/objects/shopping_list" \
  -H "GROCY-API-KEY: $API_KEY" | jq '.[].product.name'

Part 9: Home Assistant Integration

Grocy integrates directly with Home Assistant via the official integration:

  1. Home Assistant → Settings → Integrations → + Add → Grocy
  2. URL: https://home.yourdomain.com
  3. API Key: your Grocy API key

This creates sensors for:

  • sensor.grocy_due_products — items due/expiring soon
  • sensor.grocy_overdue_products — items past due date
  • sensor.grocy_missing_products — items below minimum stock
  • sensor.grocy_chores_due — chores due today/overdue

Use in automations:

# Notify when fridge items expire tomorrow:
automation:
  trigger:
    platform: state
    entity_id: sensor.grocy_due_products
  condition:
    condition: template
    value_template: "{{ states('sensor.grocy_due_products') | int > 0 }}"
  action:
    service: notify.mobile_app_phone
    data:
      message: "{{ states('sensor.grocy_due_products') }} items expiring soon!"

Maintenance

# Update Grocy:
docker compose pull
docker compose up -d

# Backup:
tar -czf grocy-backup-$(date +%Y%m%d).tar.gz \
  $(docker volume inspect grocy_grocy_config --format '{{.Mountpoint}}')

# Logs:
docker compose logs -f grocy

Why Self-Host Grocy?

The case for self-hosting Grocy comes down to three practical factors: data ownership, cost at scale, and operational control.

Data ownership is the fundamental argument. When you use a SaaS version of any tool, your data lives on someone else's infrastructure subject to their terms of service, their security practices, and their business continuity. If the vendor raises prices, gets acquired, changes API limits, or shuts down, you're left scrambling. Self-hosting Grocy means your data and configuration stay on infrastructure you control — whether that's a VPS, a bare metal server, or a home lab.

Cost at scale matters once you move beyond individual use. Most SaaS equivalents charge per user or per data volume. A self-hosted instance on a $10-20/month VPS typically costs less than per-user SaaS pricing for teams of five or more — and the cost doesn't scale linearly with usage. One well-configured server handles dozens of users for a flat monthly fee.

Operational control is the third factor. The Docker Compose configuration above exposes every setting that commercial equivalents often hide behind enterprise plans: custom networking, environment variables, storage backends, and authentication integrations. You decide when to update, how to configure backups, and what access controls to apply.

The honest tradeoff: you're responsible for updates, backups, and availability. For teams running any production workloads, this is familiar territory. For individuals, the learning curve is real but the tooling (Docker, Caddy, automated backups) is well-documented and widely supported.

Server Requirements and Sizing

Before deploying Grocy, assess your server capacity against expected workload.

Minimum viable setup: A 1 vCPU, 1GB RAM VPS with 20GB SSD is sufficient for personal use or small teams. Most consumer VPS providers — Hetzner, DigitalOcean, Linode, Vultr — offer machines in this range for $5-10/month. Hetzner offers excellent price-to-performance for European and US regions.

Recommended production setup: 2 vCPUs with 4GB RAM and 40GB SSD handles most medium deployments without resource contention. This gives Grocy headroom for background tasks, caching, and concurrent users while leaving capacity for other services on the same host.

Storage planning: The Docker volumes in this docker-compose.yml store all persistent Grocy data. Estimate your storage growth rate early — for data-intensive tools, budget for 3-5x your initial estimate. Hetzner Cloud and Vultr both support online volume resizing without stopping your instance.

Operating system: Any modern 64-bit Linux distribution works. Ubuntu 22.04 LTS and Debian 12 are the most commonly tested configurations. Ensure Docker Engine 24.0+ and Docker Compose v2 are installed — verify with docker --version and docker compose version. Avoid Docker Desktop on production Linux servers; it adds virtualization overhead and behaves differently from Docker Engine in ways that cause subtle networking issues.

Network: Only ports 80 and 443 need to be publicly accessible when running behind a reverse proxy. Internal service ports should be bound to localhost only. A minimal UFW firewall that blocks all inbound traffic except SSH, HTTP, and HTTPS is the single most effective security measure for a self-hosted server.

Backup and Disaster Recovery

Running Grocy without a tested backup strategy is an unacceptable availability risk. Docker volumes are not automatically backed up — if you delete a volume or the host fails, data is gone with no recovery path.

What to back up: The named Docker volumes containing Grocy's data (database files, user uploads, application state), your docker-compose.yml and any customized configuration files, and .env files containing secrets.

Backup approach: For simple setups, stop the container, archive the volume contents, then restart. For production environments where stopping causes disruption, use filesystem snapshots or database dump commands (PostgreSQL pg_dump, SQLite .backup, MySQL mysqldump) that produce consistent backups without downtime.

For a complete automated backup workflow that ships snapshots to S3-compatible object storage, see the Restic + Rclone backup guide. Restic handles deduplication and encryption; Rclone handles multi-destination uploads. The same setup works for any Docker volume.

Backup cadence: Daily backups to remote storage are a reasonable baseline for actively used tools. Use a 30-day retention window minimum — long enough to recover from mistakes discovered weeks later. For critical data, extend to 90 days and use a secondary destination.

Restore testing: A backup that has never been restored is a backup you cannot trust. Once a month, restore your Grocy backup to a separate Docker Compose stack on different ports and verify the data is intact. This catches silent backup failures, script errors, and volume permission issues before they matter in a real recovery.

Security Hardening

Self-hosting means you are responsible for Grocy's security posture. The Docker Compose setup provides a functional base; production deployments need additional hardening.

Always use a reverse proxy: Never expose Grocy's internal port directly to the internet. The docker-compose.yml binds to localhost; Caddy or Nginx provides HTTPS termination. Direct HTTP access transmits credentials in plaintext. A reverse proxy also centralizes TLS management, rate limiting, and access logging.

Strong credentials: Change default passwords immediately after first login. For secrets in docker-compose environment variables, generate random values with openssl rand -base64 32 rather than reusing existing passwords.

Firewall configuration:

ufw default deny incoming
ufw allow 22/tcp
ufw allow 80/tcp
ufw allow 443/tcp
ufw enable

Internal service ports (databases, admin panels, internal APIs) should only be reachable from localhost or the Docker network, never directly from the internet.

Network isolation: Docker Compose named networks keep Grocy's services isolated from other containers on the same host. Database containers should not share networks with containers that don't need direct database access.

VPN access for sensitive services: For internal-only tools, restricting access to a VPN adds a strong second layer. Headscale is an open source Tailscale control server that puts your self-hosted stack behind a WireGuard mesh, eliminating public internet exposure for internal tools.

Update discipline: Subscribe to Grocy's GitHub releases page to receive security advisory notifications. Schedule a monthly maintenance window to pull updated images. Running outdated container images is the most common cause of self-hosted service compromises.

Troubleshooting Common Issues

Container exits immediately or won't start

Check logs first — they almost always explain the failure:

docker compose logs -f grocy

Common causes: a missing required environment variable, a port already in use, or a volume permission error. Port conflicts appear as bind: address already in use. Find the conflicting process with ss -tlpn | grep PORT and either stop it or change Grocy's port mapping in docker-compose.yml.

Cannot reach the web interface

Work through this checklist:

  1. Confirm the container is running: docker compose ps
  2. Test locally on the server: curl -I http://localhost:PORT
  3. If local access works but external doesn't, check your firewall: ufw status
  4. If using a reverse proxy, verify it's running and the config is valid: caddy validate --config /etc/caddy/Caddyfile

Permission errors on volume mounts

Some containers run as a non-root user. If the Docker volume is owned by root, the container process cannot write to it. Find the volume's host path with docker volume inspect VOLUME_NAME, check the tool's documentation for its expected UID, and apply correct ownership:

chown -R 1000:1000 /var/lib/docker/volumes/your_volume/_data

High resource usage over time

Memory or CPU growing continuously usually indicates unconfigured log rotation, an unbound cache, or accumulated data needing pruning. Check current usage with docker stats grocy. Add resource limits in docker-compose.yml to prevent one container from starving others. For ongoing visibility into resource trends, deploy Prometheus + Grafana or Netdata.

Data disappears after container restart

Data stored in the container's writable layer — rather than a named volume — is lost when the container is removed or recreated. This happens when the volume mount path in docker-compose.yml doesn't match where the application writes data. Verify mount paths against the tool's documentation and correct the mapping. Named volumes persist across container removal; only docker compose down -v deletes them.

Keeping Grocy Updated

Grocy follows a regular release cadence. Staying current matters for security patches and compatibility. The update process with Docker Compose is straightforward:

docker compose pull          # Download updated images
docker compose up -d         # Restart with new images
docker image prune -f        # Remove old image layers (optional)

Read the changelog before major version updates. Some releases include database migrations or breaking configuration changes. For major version bumps, test in a staging environment first — run a copy of the service on different ports with the same volume data to validate the migration before touching production.

Version pinning: For stability, pin to a specific image tag in docker-compose.yml instead of latest. Update deliberately after reviewing the changelog. This trades automatic patch delivery for predictable behavior — the right call for business-critical services.

Post-update verification: After updating, confirm Grocy is functioning correctly. Most services expose a /health endpoint that returns HTTP 200 — curl it from the server or monitor it with your uptime tool.


See all open source home management tools at OSSAlt.com/categories/home.

The SaaS-to-Self-Hosted Migration Guide (Free PDF)

Step-by-step: infrastructure setup, data migration, backups, and security for 15+ common SaaS replacements. Used by 300+ developers.

Join 300+ self-hosters. Unsubscribe in one click.