From 50bbf24762c191ee2ffff0d61ae160735e8822fd Mon Sep 17 00:00:00 2001 From: Alexandre <44178713+alexbelgium@users.noreply.github.com> Date: Wed, 12 Jan 2022 18:39:06 +0100 Subject: [PATCH] Update README.md --- tandoor_recipes/README.md | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/tandoor_recipes/README.md b/tandoor_recipes/README.md index 5b4093746..0bcfcca60 100644 --- a/tandoor_recipes/README.md +++ b/tandoor_recipes/README.md @@ -16,6 +16,21 @@ _Thanks to everyone having starred my repo! To star it click on the image below, [Tandoor recipes](https://github.com/TandoorRecipes/recipes) is meant for people with a collection of recipes they want to share with family and friends or simply store them in a nicely organized way. A basic permission system exists but this application is not meant to be run as a public page. +## Configuration + +Please check Tandoor Recipes documentation : https://docs.tandoor.dev/install/docker/ + +```yaml + "SECRET_KEY": "str", + "DB_TYPE": "list(sqlite|postgresql_external|mariadb_addon)" # Mariadb is automatically configured is the addon is installed, sqlite does not need configuration + "ALLOWED_HOSTS": "str?", + "POSTGRES_HOST": "str?", # Needed for postgresql_external + "POSTGRES_PORT": "str?", # Needed for postgresql_external + "POSTGRES_USER": "str?", # Needed for postgresql_external + "POSTGRES_PASSWORD": "str?", # Needed for postgresql_external + "POSTGRES_DB": "str?" # Needed for postgresql_external +``` + ## Installation The installation of this add-on is pretty straightforward and not different in @@ -28,22 +43,13 @@ comparison to installing any other Hass.io add-on. 1. Check the logs of the add-on to see if everything went well. 1. Carefully configure the add-on to your preferences, see the official documentation for for that. -## Configuration - -- Start the addon. Wait a while and check the log for any errors. -- Open yourdomain.com:8000 (where ":8000" is the port configured in the addon). -- Default - - Username: `admin` - - Password: `adminadmin` - -```yaml - -``` - ## Support If you have in issue with your installation, please be sure to checkout github. +## Screenshot +![image](https://github.com/TandoorRecipes/recipes/raw/develop/docs/preview.png) + [repository]: https://github.com/alexbelgium/hassio-addons [smb-shield]: https://img.shields.io/badge/smb-yes-green.svg [openvpn-shield]: https://img.shields.io/badge/openvpn-yes-green.svg