mirror of
https://github.com/hassio-addons/addon-grocy.git
synced 2025-05-04 11:11:30 +00:00
320 lines
10 KiB
Markdown
Executable file
320 lines
10 KiB
Markdown
Executable file
# Community Hass.io Add-ons: Grocy
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
![Project Stage][project-stage-shield]
|
|
[![License][license-shield]](LICENSE.md)
|
|
|
|
![Supports armhf Architecture][armhf-shield]
|
|
![Supports armv7 Architecture][armv7-shield]
|
|
![Supports aarch64 Architecture][aarch64-shield]
|
|
![Supports amd64 Architecture][amd64-shield]
|
|
![Supports i386 Architecture][i386-shield]
|
|
|
|
[![GitLab CI][gitlabci-shield]][gitlabci]
|
|
![Project Maintenance][maintenance-shield]
|
|
[![GitHub Activity][commits-shield]][commits]
|
|
|
|
[![Discord][discord-shield]][discord]
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
|
|
|
|
[![Support my work on Patreon][patreon-shield]][patreon]
|
|
|
|
ERP beyond your fridge! A groceries & household management solution
|
|
for your home.
|
|
|
|
|
|
|
|
## About
|
|
|
|
[Grocy][grocy] - ERP beyond your fridge is a powerful groceries & household
|
|
management solution for your home, delivering features like:
|
|
|
|
- Stock management
|
|
- Shopping list
|
|
- Recipes
|
|
- Chores & tasks
|
|
- Inventory
|
|
- and many more.
|
|
|
|
[Try out the online demo of Grocy][grocy-demo].
|
|
|
|
## Installation
|
|
|
|
The installation of this add-on is pretty straightforward and not different in
|
|
comparison to installing any other Hass.io add-on.
|
|
|
|
1. Search for the "Grocy" add-on in the Hass.io add-on store.
|
|
1. Install the "Grocy" add-on.
|
|
1. Start the "Grocy" add-on.
|
|
1. Check the logs of the "Grocy" add-on to see if everything went well.
|
|
1. Click on the "OPEN WEB UI" button to get into the interface of Grocy.
|
|
1. The default login is user: `admin` password: `admin`.
|
|
1. Enjoy the add-on!
|
|
|
|
## Configuration
|
|
|
|
**Note**: _Remember to restart the add-on when the configuration is changed._
|
|
|
|
Example add-on configuration:
|
|
|
|
```json
|
|
{
|
|
"culture": "en",
|
|
"currency": "USD",
|
|
"entry_page": "stock",
|
|
"features": {
|
|
"batteries": true,
|
|
"calendar": true,
|
|
"chores": true,
|
|
"equipment": true,
|
|
"recipes": true,
|
|
"shoppinglist": true,
|
|
"tasks": true
|
|
},
|
|
"tweaks": {
|
|
"chores_assignment": true,
|
|
"multiple_shopping_lists": true,
|
|
"stock_best_before_date_tracking": true,
|
|
"stock_location_tracking": true,
|
|
"stock_price_tracking": true,
|
|
"stock_product_opened_tracking": true
|
|
},
|
|
"log_level": "info",
|
|
"ssl": false,
|
|
"certfile": "fullchain.pem",
|
|
"keyfile": "privkey.pem"
|
|
}
|
|
```
|
|
|
|
**Note**: _This is just an example, don't copy and paste it! Create your own!_
|
|
|
|
### Option: `log_level`
|
|
|
|
The `log_level` option controls the level of log output by the addon and can
|
|
be changed to be more or less verbose, which might be useful when you are
|
|
dealing with an unknown issue. Possible values are:
|
|
|
|
- `trace`: Show every detail, like all called internal functions.
|
|
- `debug`: Shows detailed debug information.
|
|
- `info`: Normal (usually) interesting events.
|
|
- `warning`: Exceptional occurrences that are not errors.
|
|
- `error`: Runtime errors that do not require immediate action.
|
|
- `fatal`: Something went terribly wrong. Add-on becomes unusable.
|
|
|
|
Please note that each level automatically includes log messages from a
|
|
more severe level, e.g., `debug` also shows `info` messages. By default,
|
|
the `log_level` is set to `info`, which is the recommended setting unless
|
|
you are troubleshooting.
|
|
|
|
### Option: `ssl`
|
|
|
|
Enables/Disables SSL (HTTPS) on the web interface of Grocy
|
|
Panel. Set it `true` to enable it, `false` otherwise.
|
|
|
|
### Option: `certfile`
|
|
|
|
The certificate file to use for SSL.
|
|
|
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
|
|
|
|
### Option: `keyfile`
|
|
|
|
The private key file to use for SSL.
|
|
|
|
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
|
|
|
|
### Option: `culture`
|
|
|
|
Is used for setting the language. Choose between:
|
|
|
|
- `da` (Danish)
|
|
- `de` (German)
|
|
- `en` (English)
|
|
- `es` (Spanish)
|
|
- `fr` (French)
|
|
- `it` (Italian)
|
|
- `nl` (Dutch)
|
|
- `no` (Norwegian)
|
|
- `pl` (Polish)
|
|
- `ru` (Russian)
|
|
- `sv_SE` (Swedish - Sweden)
|
|
- `ta` (Tamil)
|
|
- `tr` (Turkish)
|
|
|
|
### Option: `currency`
|
|
|
|
Determines the currency as displayed in the Grocy interface, specified by the
|
|
ISO4217 three digit currency code.
|
|
|
|
Examples: `USD`, `CAD`, `GBP` or `EUR`.
|
|
|
|
### Option: `entry_page`
|
|
|
|
Allows you to specify an custom homepage if desired.
|
|
|
|
You can use the one of the following values:
|
|
|
|
- `batteries`
|
|
- `calendar`
|
|
- `chores`
|
|
- `equipment`
|
|
- `mealplan`
|
|
- `recipes`
|
|
- `shoppinglist`
|
|
- `stock`
|
|
- `tasks`
|
|
|
|
By default the homepage is set to the stock overview.
|
|
|
|
### Option: `features`
|
|
|
|
Is used for enable or disable features in Grocy. Disabled features
|
|
are hidden from the web interface. The following features can be enabled
|
|
or disabled:
|
|
|
|
- `batteries`
|
|
- `calendar`
|
|
- `chores`
|
|
- `equipment`
|
|
- `recipes`
|
|
- `shoppinglist`
|
|
- `tasks`
|
|
|
|
Set it `true` to enable it, `false` otherwise.
|
|
|
|
### Option: `tweaks`
|
|
|
|
These options are used to tweak part of the core behavior of Grocy.
|
|
The following sub features can be enabled or disabled:
|
|
|
|
- `chores_assignment`
|
|
- `multiple_shopping_lists`
|
|
- `stock_best_before_date_tracking`
|
|
- `stock_location_tracking`
|
|
- `stock_price_tracking`
|
|
- `stock_product_opened_tracking`
|
|
|
|
Set it `true` to enable it, `false` otherwise.
|
|
|
|
## Known issues and limitations
|
|
|
|
- Grocy support to provide custom lookup resources to lookup information
|
|
on the internet based on the product barcode. This is currently not yet
|
|
supported by the add-on.
|
|
|
|
## Changelog & Releases
|
|
|
|
This repository keeps a change log using [GitHub's releases][releases]
|
|
functionality. The format of the log is based on
|
|
[Keep a Changelog][keepchangelog].
|
|
|
|
Releases are based on [Semantic Versioning][semver], and use the format
|
|
of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
|
|
based on the following:
|
|
|
|
- ``MAJOR``: Incompatible or major changes.
|
|
- ``MINOR``: Backwards-compatible new features and enhancements.
|
|
- ``PATCH``: Backwards-compatible bugfixes and package updates.
|
|
|
|
## Support
|
|
|
|
Got questions?
|
|
|
|
You have several options to get them answered:
|
|
|
|
- The [Community Hass.io Add-ons Discord chat server][discord] for add-on
|
|
support and feature requests.
|
|
- The [Home Assistant Discord chat server][discord-ha] for general Home
|
|
Assistant discussions and questions.
|
|
- The Home Assistant [Community Forum][forum].
|
|
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
|
|
|
|
You could also [open an issue here][issue] GitHub.
|
|
|
|
## Contributing
|
|
|
|
This is an active open-source project. We are always open to people who want to
|
|
use the code or contribute to it.
|
|
|
|
We have set up a separate document containing our
|
|
[contribution guidelines](CONTRIBUTING.md).
|
|
|
|
Thank you for being involved! :heart_eyes:
|
|
|
|
## Authors & contributors
|
|
|
|
The original setup of this repository is by [Franck Nijhof][frenck].
|
|
|
|
For a full list of all authors and contributors,
|
|
check [the contributor's page][contributors].
|
|
|
|
## We have got some Hass.io add-ons for you
|
|
|
|
Want some more functionality to your Hass.io Home Assistant instance?
|
|
|
|
We have created multiple add-ons for Hass.io. For a full list, check out
|
|
our [GitHub Repository][repository].
|
|
|
|
## License
|
|
|
|
MIT License
|
|
|
|
Copyright (c) 2019 Franck Nijhof
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
|
|
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
|
|
[alpine-packages]: https://pkgs.alpinelinux.org/packages
|
|
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
|
|
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
|
|
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
|
|
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg
|
|
[buymeacoffee]: https://www.buymeacoffee.com/frenck
|
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-grocy.svg
|
|
[commits]: https://github.com/hassio-addons/addon-grocy/commits/master
|
|
[contributors]: https://github.com/hassio-addons/addon-grocy/graphs/contributors
|
|
[discord-ha]: https://discord.gg/c5DvZ4e
|
|
[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
|
|
[discord]: https://discord.me/hassioaddons
|
|
[dockerhub]: https://hub.docker.com/r/hassioaddons/grocy
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
|
|
[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-grocy/112422?u=frenck
|
|
[frenck]: https://github.com/frenck
|
|
[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-grocy/badges/master/pipeline.svg
|
|
[gitlabci]: https://gitlab.com/hassio-addons/addon-grocy/pipelines
|
|
[grocy]: https://grocy.info/
|
|
[grocy-demo]: https://demo-en.grocy.info
|
|
[home-assistant]: https://home-assistant.io
|
|
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
|
|
[issue]: https://github.com/hassio-addons/addon-grocy/issues
|
|
[keepchangelog]: http://keepachangelog.com/en/1.0.0/
|
|
[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-grocy.svg
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg
|
|
[microbadger]: https://microbadger.com/images/hassioaddons/grocy
|
|
[patreon-shield]: https://www.frenck.nl/images/patreon.png
|
|
[patreon]: https://www.patreon.com/
|
|
[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
|
|
[python-packages]: https://pypi.org/
|
|
[reddit]: https://reddit.com/r/homeassistant
|
|
[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-grocy.svg
|
|
[releases]: https://github.com/hassio-addons/addon-grocy/releases
|
|
[repository]: https://github.com/hassio-addons/repository
|
|
[semver]: http://semver.org/spec/v2.0.0.htm
|