Skip to content

Commit b11f475

Browse files
committed
docs: update
1 parent b35b050 commit b11f475

File tree

9 files changed

+23
-4
lines changed

9 files changed

+23
-4
lines changed

Diff for: docs/get-started.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,16 @@ There are three tags available: `latest`, `beta` and `dev`. `latest` is the most
5858
docker run -d -p 5000:80 --name=kitchenowl --restart=unless-stopped -v kitchenowl_data:/data tombursch/kitchenowl:latest
5959
```
6060

61-
:exclamation: We recommend running KitchenOwl behind a reverse proxy with https (e.g. [nginx](https://nginx.org/en/docs/http/configuring_https_servers.html])) :exclamation:
61+
!!! danger "Important"
62+
We recommend running KitchenOwl behind a reverse proxy with https (e.g. [nginx](https://nginx.org/en/docs/http/configuring_https_servers.html]))
63+
64+
It is also important that you have HTTP Strict Forward Secrecy enabled and the proper headers applied to your responses or you could be subject to a javascript hijack.
65+
66+
Please see:
67+
68+
- [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security)
69+
- [https://www.netsparker.com/blog/web-security/http-security-headers/](https://www.netsparker.com/blog/web-security/http-security-headers/)
70+
6271

6372
## ⏫ Migrating from Older Versions
6473
Starting from version 0.0.33 the frontend routes requests to the backend. Thus only one port has to be accessible. However, the backend can be hosted in standalone mode as it was before (see legacy server install).

Diff for: docs/img/screenshots/balance.png

41.1 KB
Loading

Diff for: docs/img/screenshots/groceries.png

104 KB
Loading

Diff for: docs/img/screenshots/plan.png

1.01 MB
Loading

Diff for: docs/img/screenshots/recipe.png

861 KB
Loading

Diff for: docs/img/screenshots/theme.png

103 KB
Loading

Diff for: docs/index.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Overview
2+
23
<h3 align="center">
34
A grocery list and recipe manager
45
</h3>
@@ -16,7 +17,6 @@
1617
<img alt='Get it on TestFlight' src='img/badges/testflight.png' style="height:60px"/>
1718
</a>
1819

19-
2020
## ✨ Features
2121

2222
The following features have been implemented:
@@ -28,7 +28,7 @@ The following features have been implemented:
2828
- Manage balances and track expenses
2929
- Mobile/Web/Desktop apps
3030

31-
This project is still in development, so some features may not be fully implemented yet.
31+
Please keep in mind that this project is still in development.
3232

3333
For a list of planned features, check out the [Roadmap](roadmap.md)!
3434

@@ -42,9 +42,10 @@ For a list of planned features, check out the [Roadmap](roadmap.md)!
4242
<img alt="Suggestions page" src="img/screenshots/suggestions.png" width="31%" hspace="5"/>
4343

4444
## 📟 Social
45+
4546
Join our [Matrix Space](https://matrix.to/#/#kitchenowl:matrix.org) and get involved!
4647

4748
## 📜 License
4849

4950
KitchenOwl is Free Software: You can use, study share and improve it at your will. Specifically you can redistribute and/or modify it under the terms of the AGPL-3.0 License.
50-
[Read the License](about/license.md){ .md-button }
51+
[Read the License](about/license.md){ .md-button }

Diff for: docs/tips-and-tricks.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# Tips & Tricks
2+
23
There are a few hidden features in the app which might not be obvious at first.
34

45
### Item description
6+
57
When searching for an item you can add the `,` delimiter to add descriptions directly.
68
Did you also know that pressing enter when searching adds the first item to your shopping list?
79

810
![video](img/screenshots/description.gif)
911

1012
### More details
13+
1114
Every card supports long presses to show details. So next time you look at your planned meals just long press and see how to cook it!
1215

1316
![video](img/screenshots/more-info.gif)
17+
18+
### Share to the App
19+
20+
You can share links with the kitchenowl mobile to app to directly add it to your recipe list.

Diff for: mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,11 @@ extra:
3131
- icon: fontawesome/brands/docker
3232
link: https://hub.docker.com/u/tombursch
3333
markdown_extensions:
34+
- admonition
3435
- attr_list
3536
- def_list
3637
- md_in_html
38+
- pymdownx.details
3739
- pymdownx.superfences
3840
- pymdownx.tabbed:
3941
alternate_style: true

0 commit comments

Comments
 (0)