README

-----



ERP beyond your fridge
Grocy is a web-based self-hosted groceries & household management solution for your home
This is a hobby project by Bernd Bestel


-----

 Give it a try

- Public demo of the latest stable version (release branch) → https://demo.grocy.info
- Public demo of the current development version (master branch) → https://demo-prerelease.grocy.info

 Features

See the website. → 

 Questions / Help / Bug Reports / Feature Requests

- General help and usage questions →  r/grocy on Reddit
- Bug Reports and Feature Requests → Issue Tracker

_Please don't send me private messages or call me regarding anything Grocy. I check the issue tracker and the subreddit pretty much daily, but don't provide any support beyond that._

 Community contributions

See the website for a list of community contributed Add-ons / Tools. → https://grocy.info/addons

 How to install

 Checkout Grocy Desktop, if you want to run Grocy without having to manage a webserver just like a normal (Windows) desktop application.

 Directly download the latest release (also available via the Microsoft Store) - the installation is nothing more than just clicking 2 times "next".

Grocy is technically a pretty simple PHP application, so the basic notes to get it running are:
- Unpack the latest release
- Copy config-dist.php to data/config.php + edit to your needs
- Ensure that the data directory is writable
- The webserver root should point to the public directory
- Include try_files $uri /index.php$is_args$query_string; in your location block if you use nginx
  - Or disable URL rewriting (see the option DISABLE_URL_REWRITING in data/config.php)
- → Default login is user admin with password admin, please change the password immediately (user menu at the top right corner)

Alternatively clone this repository (the release branch always references the latest released version) and install Composer and Yarn dependencies manually.

See the website for more installation guides and troubleshooting help. → https://grocy.info/links

 Platform support

- PHP 8.5 (with SQLite 3.40+)
  - Required PHP extensions: fileinfo, pdo_sqlite, gd, ctype, intl, zlib, mbstring
- Recent Firefox, Chrome or Edge

 How to run using Docker

→ https://hub.docker.com/r/linuxserver/grocy

 How to update

- Overwrite everything with the latest release while keeping the data directory
- Check config-dist.php for new configuration options and add them to your data/config.php where appropriate (the default values from config-dist.php will be used for not in data/config.php defined settings)

If you run Grocy on Linux, there is also update.sh (remember to make the script executable via chmod +x update.sh and ensure that you have unzip installed) which does exactly this and additionally creates a backup (.tgz archive) of the current installation in data/backups (backups older than 60 days will be deleted during the update).

 Localization

Grocy is fully loca