Skip to content

Commit 426f6a7

Browse files
committed
📝 Adds list of data stored in Local Storage
1 parent b9e9db3 commit 426f6a7

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

docs/privacy.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ For privacy and security tips, check out another project of mine: **[Personal Se
1111
By default, Dashy will not make any external requests, unless you configure it to. Some features (which are all off by default) do require internat access, and this section outlines those features, the services used, and links to their privacy policies.
1212

1313
### Font Awesome
14-
If either sections or items are using font-awesome icons, then these will be fetched directly from font-awesome on page load.
14+
If either any of your sections or items are using font-awesome icons, then these will be fetched directly from font-awesome on page load. See the [Font Awesome Privacy Policy](https://fontawesome.com/privacy) for more info.
1515

1616
### Favicon Fetching
1717
If an item's icon is set to `favicon`, then it will be auto-fetched from the corresponding URL. Since not all websites have their icon located at `/favicon.ico`, and if they do, it's often very low resolution (like `16 x 16 px`). Therefore, the default behavior is for Dashy to check if the URL is public, and if so will use an API to fetch the favicon. For self-hosted services, the favion will be fetched from the default path, and no external requests will be made.
@@ -41,10 +41,39 @@ If you need to monitor bugs yourself, then you can [self-host your own Sentry Se
4141

4242
---
4343

44+
## Local Storage
45+
In order for user preferences to be persisted between sessions, certain data needs to be stored in the browsers local storage. No personal info is kept here, none of this data can be accessed by other domains, and no data is ever sent to any server without your prior consent.
46+
You can view your browsers session storage by opening up the dev tools (F12) --> Application --> Storage.
47+
48+
The following section outlines all data that is stored in the browsers, as cookies or local storage.
49+
50+
#### Cookies
51+
- `AUTH_TOKEN` - A unique token, generated from a hash of users credentials, to verify they are authenticated. Only used when auth is enabled
52+
53+
#### Local Storage
54+
- `LANGUAGE` - The locale to show app text in
55+
- `HIDE_WELCOME_BANNER` - Set to true once user dismissed welcome message, so that it's not shown again
56+
- `LAYOUT_ORIENTATION` - Preferred section layout, either horizontal, vertical or auto
57+
- `COLLAPSE_STATE` - Remembers which sections are collapsed
58+
- `ICON_SIZE` - Size of items, either small, medium or large
59+
- `THEME: 'theme` - Users applied theme
60+
- `CUSTOM_COLORS` - Any color modifications made to a given theme
61+
- `BACKUP_ID` - If a backup has been made, the ID is stored here
62+
- `BACKUP_HASH` - A unique hash of the previous backups meta data
63+
- `HIDE_SETTINGS` - Lets user hide or show the settings menu
64+
- `USERNAME` - If user logged in, store username in order to welcome them
65+
- `CONF_SECTIONS` - Array of sections, only used when user applies changes locally
66+
- `PAGE_INFO` - Config page info, only used when user applies changes locally
67+
- `APP_CONFIG` - App config, only used when user applies changes locally
68+
69+
---
70+
4471
## Dependencies
4572
As with most web projects, Dashy relies on several [dependencies](https://github.com/Lissy93/dashy/blob/master/docs/credits.md#dependencies-). For links to each, and a breakdown of their licenses, please see [Legal](https://github.com/Lissy93/dashy/blob/master/.github/LEGAL.md).
4673

47-
Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see [the latest report here](https://snyk.io/test/github/lissy93/dashy).
74+
Dependencies can introduce security vulnerabilities, but since all these packages are open source any issues are usually very quickly spotted. Dashy is using Snyk for dependency security monitoring, and you can see [the latest report here](https://snyk.io/test/github/lissy93/dashy). If any issue is detected by Snyk, a note about it will appear at the top of the Reamde, and will usually be fixed within 48 hours.
75+
76+
Note that packages listed under `deDependencies` section are only used for building the project, and are not included in the production environment.
4877

4978
---
5079

0 commit comments

Comments
 (0)