Keridos / grocy-docker

ERP beyond your fridge - now containerized - this is the docker repo of https://github.com/grocy/grocy

grocy-docker

ERP beyond your fridge - now containerized!

This repository includes container build infrastructure for grocy.

Prerequisites

Follow these instructions to get Docker running on your server.

Quickstart

To get started using pre-built Docker Hub grocy images, run the following commands:

docker-compose pull
docker-compose up

The grocy application should now be accessible locally to the server:

• http://localhost
• https://localhost

Since the images contain self-signed certificates, your browser may display a warning when visiting the HTTPS URL.

Configuration

The grocy application reads configuration settings from environment variables prefixed by GROCY_.

Runtime environment variables are read by docker-compose from the grocy.env file in this directory.

The default login credentials are username admin and password admin; please change these before providing end-user access to your deployment.

Demo Mode

To run the container in demo mode, override the GROCY_MODE environment variable at application run-time:

GROCY_MODE=demo docker-compose up

Build

Docker Images

docker-compose build

Note: if you experience build failures as a result of GitHub API rate limiting, you may optionally provide a GitHub API key (preferably restricted to read:packages scope) at build-time:

GITHUB_API_TOKEN='your-token-here' docker-compose build

Vulnerability Scans

Support is provided for running image vulnerability scans using the snyk CLI tool.

This requires authentication with Snyk during the vulnerability scanning process.

You can read more about Snyk's vulnerability database here.

To perform a vulnerability scan, use the following command:

npm run test

OCI Images

Optional support for building opencontainer images is available via the Makefile provided.