Skip to content

setup.md

Latest commit

 

History

History
117 lines (79 loc) · 6 KB

setup.md

File metadata and controls

117 lines (79 loc) · 6 KB

Setup

Installation

Grocy can be installed in many ways.

  • Windows application (runs as a normal windows application).
  • Docker or Podman Container.
  • Home Assistant Add-on.
  • On your existing PHP enabled web server.

Windows Application

Installed as a normal application. For more information see grocy-desktop readme.

Docker Container

There are two maintained docker images, grocy/grocy-docker and linuxserver/docker-grocy. The official docker container comes with everything needed to get started from scratch, the linuxserver container is more suitable if you already got a reverse proxy solution running.

If you do not have docker and docker-compose installed you have to install them by following these instructions for docker and these for docker-compose. If you are using Podman you may or may not want to use podman-compose.

Now you have to download the files, either manually from grocy/grocy-docker or with git.

In a terminal, navigate to where you want your install to be. Then run the following commands:

git clone https://github.com/grocy/grocy-docker
cd grocy-docker
docker-compose pull
docker-compose up -d

depending on your setup you might need to write sudo docker-compose instead of docker-compose.

If your container is running on the same computer as your web browser you can access it here:

Or if it is running on a remote server access, it like this instead:

  • http://< ip-address-of-your-server >
  • https://< ip-address-of-your-server >

Home Assistant Add-on

If you have an extra Raspberry Pi this might be the easiest solution. Home Assistant is a home automation system that has Grocy as an add-on. Follow these instructions to get Home Assistant running on you Raspberry Pi.

When you have entered Home Assistant and see this screen select the supervisor, add-on store, search for Grocy, select Grocy, click install, start the add-on, click the "OPEN WEB UI" to get to the Grocy screen.

Home Assistant

Existing web server

If you have a web server running and would like to run Grocy on it. The How to install documentation on GitHub is probably enough to get you up and running.

Setting up users

You can set up your users once you log in with the default admin account (user admin with same password - you should change this for security reasons, of course, by clicking the username and selecting change password).

Choose the main settings (wrench icon on the top right), and select Manage users. Here you can Add new users, edit and delete existing ones. New users require at minimum a username and a password.

! All users have administrator rights.

User specific settings

User specific settings control basic interface settings. They can, for example, be used to prevent a tablet being used in the kitchen from going to sleep or cause it to have a less bright appearance at night. The kitchen tablet in this example would be its own user.

Grocy Settings

Many important settings in Grocy such as the language, currency and first day of the week (Sunday, Monday, etc.), used by your Grocy server, as well as disabling unwanted features, are changed by editing a text file.

You will find a folder named data inside the folder you installed Grocy into. In that folder you will find a file named config.php. This config file can be opened with any text editor.

On a linux server this file can be opened by

nano path-to-grocy/data/config.php

Part of the config file is seen below:

# Either "production", "dev", "demo" or "prerelease"
# When not "production", authentication will be disabled and
# demo data will be populated during database migrations
Setting('MODE', 'production');

# Either "en" or "de" or the directory name of
# one of the other available localization folders in the "/localization" directory
Setting('CULTURE', 'en');

# This is used to define the first day of a week for calendar views in the frontend,
# leave empty to use the locale default
# Needs to be a number where Sunday = 0, Monday = 1 and so forth
Setting('CALENDAR_FIRST_DAY_OF_WEEK', '0');

A line that starts with # is a comment to help you as a user understand following setting and how you can edit it. The comment is ignored by Grocy.

By changing production to demo your Grocy will be filled with example data. Same as in this demo.

Setting('MODE', 'demo');

When you use Grocy to manage your home, you want the MODE setting to be set to production. All other options are more dependent on how you want Grocy to behave. (Tip: To actually make Grocy usable for your home and routines, disabling features can often be the key.)

Depending on how you run your Grocy instance, you might need to restart it after changes to the config.

Please see the examples section for some ideas of how you can setup Grocy.

Helpful tools

There are some great tools that can interact with Grocy that might be useful for you. Here is a short list that is most likely complete:

  • PantryParty - iOS and Android app.
  • Barcode Buddy - Barcode scanner tool. To make using physical scanner more efficient.
  • Home Assistant - Home automation project with a Grocy Add-on and custom component for integration.
  • Recipe Buddy - Import recipes from web sites.
  • pygrocy
  • pygrocydm
  • grocy-pyscanner