Merge branch 'develop'

.env.template

@@ -45,7 +45,8 @@ SHOPPING_MIN_AUTOSYNC_INTERVAL=5
 # Default for user setting sticky navbar
 # STICKY_NAV_PREF_DEFAULT=1
 
-# If base URL is something other than just /  (you are serving a subfolder in your proxy for instance http://recipe_app/recipes/)
+# If base URL is something other than just / (you are serving a subfolder in your proxy for instance http://recipe_app/recipes/)
+# Be sure to not have a trailing slash: e.g. '/recipes' instead of '/recipes/'
 # SCRIPT_NAME=/recipes
 
 # If staticfiles are stored at a different location uncomment and change accordingly, MUST END IN /
@@ -145,3 +146,7 @@ REVERSE_PROXY_AUTH=0
 #AUTH_LDAP_BIND_DN=
 #AUTH_LDAP_BIND_PASSWORD=
 #AUTH_LDAP_USER_SEARCH_BASE_DN=
+
+# Enables exporting PDF (see export docs)
+# Disabled by default, uncomment to enable
+# ENABLE_PDF_EXPORT=1

.github/ISSUE_TEMPLATE/bug_report.md.bak

@@ -0,0 +1,81 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Version
+<!-- Please provide your current version (can be found on the system page since v0.8.4). -->
+**Tandoor-Version:** 
+
+## Setup configuration
+<!--Please tick all boxes which apply to your configuration. Feel free to provide additional information below.  
+To tick boxes here, simply put an X inside the brackets below -->
+
+### Setup
+- [ ] Docker / Docker-Compose
+- [ ] Unraid
+- [ ] Synology
+- [ ] Kubernetes
+- [ ] Manual setup
+- [ ] Others (please state below)
+
+### Reverse Proxy
+- [ ] No reverse proxy
+- [ ] jwilder's nginx proxy
+- [ ] Nginx proxy manager (NPM)
+- [ ] SWAG
+- [ ] Caddy
+- [ ] Traefik
+- [ ] Others (please state below)
+
+<!-- Please provide additional information if possible -->
+**Additional information:** 
+
+## Bug description
+A clear and concise description of what the bug is.
+
+
+
+## Logs
+<!-- *(Remove this section entirely if no logs are available or necessary for your issue)*  
+To get the most information about your issue, set DEBUG=1 (e.g. in your `.env` file if using docker-compose) and try to reproduce the issue afterwards.
+
+Please put your logs into the expandable section below and use code quotation for all logs! Usage: Put three backticks in front and after the log, like this:  
+` ``` <Many lines of log messages ``` ` 
+
+Feel free to remove parts if you don't fill them out.
+-->
+
+<details>
+  <summary>Web-Container-Logs</summary>
+
+  <!-- *Put your logs inside here (leave the code quotations in takt):* -->
+
+  ```
+  Replace me with logs
+  ```
+</details>
+
+<details>
+  <summary>DB-Container-Logs</summary>
+
+  <!-- *Put your logs inside here (leave the code quotations in takt):* -->
+
+  ```
+  Replace me with logs
+  ```
+</details>
+
+<details>
+  <summary>Nginx-Container-Logs <!-- if you use one --></summary>
+
+  <!-- *Put your logs inside here (leave the code quotations in takt):* -->
+
+  ```
+  Replace me with logs
+  ```
+</details>

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,64 @@
+name: Bug Report
+description: "Create a report to help us improve"
+#title: ""
+#labels: ["Bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report!
+  - type: input
+    id: version
+    attributes:
+      label: Tandoor Version
+      description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)"
+    validations:
+      required: true
+  - type: dropdown
+    id: setup
+    attributes:
+      label: Setup
+      description: "How is your Tandoor instance set up?"
+      options:
+        - Docker / Docker-Compose
+        - Unraid
+        - Synology
+        - Kubernetes
+        - Manual Setup
+        - Others (please state below)
+    validations:
+      required: true
+  - type: dropdown
+    id: reverse-proxy
+    attributes:
+      label: "Reverse Proxy"
+      description: "What reverse proxy do you use with Tandoor?"
+      options:
+        - No reverse proxy
+        - jwilder's nginx proxy
+        - Nginx Proxy Manager (NPM)
+        - SWAG
+        - Caddy
+        - Traefik
+        - Apache2
+        - Others (please state below)
+    validations:
+      required: true
+  - type: input
+    id: other
+    attributes:
+      label: Other
+      description: "In case you chose 'Others' above, please provide more info here."
+  - type: textarea
+    id: bug-descr
+    attributes:
+      label: Bug description
+      description: "Please accurately describe the bug you encountered."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant logs
+      description: Please copy and paste any relevant logs. This will be automatically formatted into code, so no need for backticks.
+      render: shell

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: FAQs
+    url: https://docs.tandoor.dev/faq/
+    about: Please take a look at the FAQs before creating a bug ticket.

.github/ISSUE_TEMPLATE/doc_issue.yml

@@ -0,0 +1,40 @@
+name: Documentation Issue
+description: "Create a report to help us improve"
+#title: ""
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this documentation issue report!
+  - type: input
+    id: docs-link
+    attributes:
+      label: Documentation link
+      description: "Please provide a link to the corresponding documentation site on docs.tandoor.dev"
+  - type: dropdown
+    id: section
+    attributes:
+      label: Affected section
+      description: "What part of the documentation is the issue about?"
+      options:
+        - Installation
+        - Features
+        - System
+        - FAQ
+        - Does not exist yet
+        - Other (please state below)
+    validations:
+      required: true
+  - type: input
+    id: other
+    attributes:
+      label: Other
+      description: "In case you chose 'Other' above, please provide more info here."
+  - type: textarea
+    id: descr
+    attributes:
+      label: Issue description
+      description: "Please accurately describe the documentation issue you are seeing."
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,39 @@
+name: Feature Request
+description: "Suggest an idea for this project"
+#title: ""
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this feature request!
+  - type: textarea
+    id: problem
+    attributes:
+      label: "Is your feature request related to a problem? Please describe."
+      description: "A clear and concise description of what the problem is. Ex. I'm always frustrated when..."
+  - type: textarea
+    id: solution
+    attributes:
+      label: "Describe the solution you'd like"
+      description: "A clear and concise description of what you want to happen."
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: "Describe alternatives you've considered"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+  - type: textarea
+    id: additional
+    attributes:
+      label: "Additional context"
+      description: "Add any other context or screenshots about the feature request here."
+  - type: checkboxes
+    attributes:
+      label: "Contribute"
+      description: "Are you willing and able to help develop this feature?"
+      options:
+        - label: "Yes"
+        - label: "Partly"
+        - label: "No"

.github/ISSUE_TEMPLATE/help_request.yml

@@ -0,0 +1,82 @@
+name: Help request
+description: "If there is anything wrong with your setup"
+#title: ""
+labels: ["setup issue"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this help request!
+  - type: textarea
+    id: issue
+    attributes:
+      label: Issue
+      description: "Please describe your problem here."
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Tandoor Version
+      description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)"
+    validations:
+      required: true
+  - type: input
+    id: os
+    attributes:
+      label: OS Version
+      description: "E.g. Ubuntu 20.02"
+    validations:
+      required: true
+  - type: dropdown
+    id: setup
+    attributes:
+      label: Setup
+      description: "How is your Tandoor instance set up?"
+      options:
+        - Docker / Docker-Compose
+        - Unraid
+        - Synology
+        - Kubernetes
+        - Manual Setup
+        - Others (please state below)
+    validations:
+      required: true
+  - type: dropdown
+    id: reverse-proxy
+    attributes:
+      label: "Reverse Proxy"
+      description: "What reverse proxy do you use with Tandoor?"
+      options:
+        - No reverse proxy
+        - jwilder's nginx proxy
+        - Nginx Proxy Manager (NPM)
+        - SWAG
+        - Caddy
+        - Traefik
+        - Others (please state below)
+    validations:
+      required: true
+  - type: input
+    id: other
+    attributes:
+      label: Other
+      description: "In case you chose 'Others' above or have more info, please provide additional details here."
+  - type: textarea
+    id: env
+    attributes:
+      label: Environment file
+      description: "Please include your `.env` config file (**make sure to remove/replace all secrets**)"
+      render: shell
+  - type: textarea
+    id: docker-compose
+    attributes:
+      label: Docker-Compose file
+      description: "When running with docker compose please provide your `docker-compose.yml`"
+      render: shell
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant logs
+      description: "If you feel like there is anything interesting please post the output of `docker-compose logs` at container startup and when the issue happens."
+      render: shell

.github/ISSUE_TEMPLATE/website_import.yml

@@ -0,0 +1,36 @@
+name: Website Import
+description: "Anything related to website imports"
+#title: ""
+#labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this website import form!
+  - type: input
+    id: version
+    attributes:
+      label: Tandoor Version
+      description: "What version of Tandoor are you using? (can be found on the system page since v0.8.4)"
+    validations:
+      required: true
+  - type: input
+    id: url
+    attributes:
+      label: Import URL
+      description: "Exact URL you are trying to import from."
+    validations:
+      required: true
+  - type: textarea
+    id: bug-descr
+    attributes:
+      label: "When did the issue happen?"
+      description: "When pressing the search button with the url / when importing after the page has loaded / ..."
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Response / message shown
+      description: Please copy and paste any relevant logs or responses / messages which are shown in Tandoor. This will be automatically formatted into code, so no need for backticks.
+      render: shell

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: Continous Integration
+name: Continuous Integration
 
 on: [push]