1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/grocy_ynh.git synced 2024-09-03 19:25:54 +02:00
grocy_ynh/README.md

74 lines
2.3 KiB
Markdown
Raw Normal View History

2020-12-16 19:56:57 +01:00
# Grocy for YunoHost
[![Integration level](https://dash.yunohost.org/integration/grocy.svg)](https://dash.yunohost.org/appci/app/grocy) ![](https://ci-apps.yunohost.org/ci/badges/grocy.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/grocy.maintain.svg)
2020-12-26 19:51:35 +01:00
[![Install Grocy with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=grocy)
2020-12-16 19:56:57 +01:00
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Grocy quickly and simply on a YunoHost server.
2021-05-27 13:19:07 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
2020-12-16 19:56:57 +01:00
## Overview
Grocy is a web-based self-hosted groceries & household management solution for your home.
2021-01-26 10:00:10 +01:00
**Shipped version:** 3.0.1
2020-12-16 19:56:57 +01:00
## Screenshots
![](https://grocy.info/img/grocy-desktop-en.png)
## Demo
* [Official demo](https://en.demo.grocy.info/stockoverview)
2020-12-16 22:41:01 +01:00
## Configuration
Default login
2021-04-11 13:30:58 +02:00
* user: **admin**
* password: **admin**
2020-12-16 22:41:01 +01:00
2020-12-16 19:56:57 +01:00
## Documentation
* Official documentation: Link to the official documentation of this app
* YunoHost documentation: If specific documentation is needed, feel free to contribute.
## YunoHost specific features
#### Multi-user support
* Are LDAP and HTTP auth supported?
* Can the app be used by multiple users?
#### Supported architectures
2021-04-11 13:30:58 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/grocy.svg)](https://ci-apps.yunohost.org/ci/apps/grocy/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/grocy.svg)](https://ci-apps-arm.yunohost.org/ci/apps/grocy/)
2020-12-16 19:56:57 +01:00
## Limitations
2021-01-22 10:30:09 +01:00
:warning: For now, Grocy must be installed in a root domain or subdirectory.
2020-12-16 19:56:57 +01:00
## Additional information
* Other info you would like to add about this app.
## Links
* Report a bug: https://github.com/YunoHost-Apps/grocy_ynh/issues
* App website: https://grocy.info/
* Upstream app repository: https://github.com/grocy/grocy
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/grocy_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/grocy_ynh/tree/testing --debug
or
sudo yunohost app upgrade grocy -u https://github.com/YunoHost-Apps/grocy_ynh/tree/testing --debug
```