From 281535e756e6ecd5a7a378a1b6eb0ae0a1900a50 Mon Sep 17 00:00:00 2001 From: tomtjes Date: Sat, 15 Jan 2022 13:57:20 -0500 Subject: [PATCH 1/2] phrase FAQ as questions --- docs/faq.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/faq.md b/docs/faq.md index 16ef0472dd..c9c5572580 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,7 +2,7 @@ There are several questions and issues that come up from time to time. Here are Please note that the existence of some questions is due the application not being perfect in some parts. Many of those shortcomings are planned to be fixed in future release but simply could not be addressed yet due to time limits. -## CSRF Errors +## Why am I getting CSRF Errors? If you are getting CSRF Errors this is most likely due to a reverse proxy not passing the correct headers. If you are using swag by linuxserver you might need `proxy_set_header X-Forwarded-Proto $scheme;` in your nginx config. @@ -10,15 +10,15 @@ If you are using a plain ngix you might need `proxy_set_header Host $http_host;` Further discussions can be found in this [Issue #518](https://github.com/vabene1111/recipes/issues/518) -## Images not loading -If images are not loading this might be related to the same issue as the CSRF Errors. -A discussion about that can be found [Issue #452](https://github.com/vabene1111/recipes/issues/452) +## Why are images not loading? +If images are not loading this might be related to the same issue as the CSRF errors (see above). +A discussion about that can be found at [Issue #452](https://github.com/vabene1111/recipes/issues/452) The other common issue is that the recommended nginx container is removed from the deployment stack. If removed, the nginx webserver needs to be replaced by something else that servers the /mediafiles/ directory or `GUNICORN_MEDIA` needs to be enabled to allow media serving by the application container itself. -## User Creation +## How can I create users? To create a new user click on your name (top right corner) and select system. There click on invite links and create a new invite link. It is not possible to create users through the admin because users must be assigned a default group and space. @@ -28,7 +28,7 @@ To change a users space you need to go to the admin and select User Infos. If you use an external auth provider or proxy authentication make sure to specify a default group and space in the environment configuration. -## Spaces +## What are spaces? Spaces are a feature used to separate one installation of Tandoor into several parts. In technical terms it is a multi tenant system. @@ -39,11 +39,16 @@ If you want to host the collection of your friends family or your neighbor you c Sharing between spaces is currently not possible but is planned for future releases. -## Create Admin user / reset passwords -To create a superuser or reset a lost password if access to the container is lost you need to +## How can I reset passwords? +To reset a lost password if access to the container is lost you need to 1. execute into the container using `docker-compose exec web_recipes sh` 2. activate the virtual environment `source venv/bin/activate` -3. run `python manage.py createsuperuser` and follow the steps shown. +3. run `python manage.py changepassword ` and follow the steps shown. -To change a password enter `python manage.py changepassword ` in step 3. \ No newline at end of file +## How can I add an admin user? +To create a superuser you need to + +1. execute into the container using `docker-compose exec web_recipes sh` +2. activate the virtual environment `source venv/bin/activate` +3. run `python manage.py createsuperuser` and follow the steps shown. \ No newline at end of file From 99b3ed84643386e1f18c7ad46ecbd1d8745000fd Mon Sep 17 00:00:00 2001 From: tomtjes Date: Sat, 15 Jan 2022 13:58:40 -0500 Subject: [PATCH 2/2] add FAQ for PWA --- docs/faq.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/faq.md b/docs/faq.md index c9c5572580..768f19fada 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -2,6 +2,22 @@ There are several questions and issues that come up from time to time. Here are Please note that the existence of some questions is due the application not being perfect in some parts. Many of those shortcomings are planned to be fixed in future release but simply could not be addressed yet due to time limits. +## Is there a Tandoor app? +Tandoor can be installed as a progressive web app (PWA) on mobile and desktop devices. The PWA stores recently accessed recipes locally for offline use. + +### Mobile browsers + +#### Safari (iPhone/iPad) +Open Tandoor, click Safari's share button, select `Add to Home Screen` + +### Desktop browsers + +#### Google Chrome +Open Tandoor, open the menu behind the three vertical dots at the top right, select `Install Tandoor Recipes...` + +#### Microsoft Edge +Open Tandoor, open the menu behind the three horizontal dots at the top right, select `Apps > Install Tandoor Recipes` + ## Why am I getting CSRF Errors? If you are getting CSRF Errors this is most likely due to a reverse proxy not passing the correct headers.