selfhosted
/
dashy
mirror of https://github.com/lissy93/dashy
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

📝 Adds privacy info for each widget in docs

This commit is contained in:
Alicia Sykes 2021-12-27 17:16:42 +00:00
parent 051ed1841c
commit 3ffdf753cc
1 changed files with 194 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
docs/widgets.md
View File

@ -72,6 +72,9 @@ A simple, live-updating time and date widget with time-zone support. All options
hideDate: false
```
##### Info
_No external data requests_
---
### Weather
@ -100,6 +103,12 @@ A simple, live-updating local weather component, showing temperature, conditions
hideDetails: false
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan
- **Privacy**: _See [OWM Privacy Policy](https://openweather.co.uk/privacy-policy)_
---
### Weather Forecast
@ -129,6 +138,12 @@ Displays the weather (temperature and conditions) for the next few days for a gi
units: imperial
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🔴 Premium (free for personal use only)
- **Privacy**: _See [OWM Privacy Policy](https://openweather.co.uk/privacy-policy)_
---
@ -171,6 +186,12 @@ Or
- dogecoin
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Privacy**: _See [CoinGecko Privacy Policy](https://www.coingecko.com/en/privacy)_
---
### Crypto Token Price History
@ -199,6 +220,12 @@ Shows recent price history for a given crypto asset, using price data fetched fr
numDays: 7
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Privacy**: _See [CoinGecko Privacy Policy](https://www.coingecko.com/en/privacy)_
---
### RSS Feed
@ -226,6 +253,13 @@ Display news and updates from any RSS-enabled service.
apiKey: xxxx
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟠 Optional
- **Price**: 🟠 Free Plan (up to 10,000 requests / day)
- **Privacy**: _See [Rss2Json Privacy Policy](https://rss2json.com/privacy-policy)_
---
### XKCD Comics
@ -248,6 +282,12 @@ Have a laugh with the daily comic from [XKCD](https://xkcd.com/). A classic webc
comic: latest
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Privacy**: ⚫ No Policy Available
---
### Code Stats
@ -276,6 +316,13 @@ Display your coding summary. [Code::Stats](https://codestats.net/) is a free and
username: alicia
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted or Managed
- **Privacy**: _See [Code::Stats Privacy Policy](https://codestats.net/tos#privacy)_
---
### Vulnerability Feed
@ -314,6 +361,13 @@ or
limit: 30
```
##### Info
- **CORS**: 🟠 Proxied
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed
- **Privacy**: _See [CVE Details Privacy Policy](https://www.cvedetails.com/privacy.php)_
---
### Public Holidays
@ -340,6 +394,13 @@ Counting down to the next day off work? This widget displays upcoming public hol
monthsToShow: 12
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [jurajmajer/enrico](https://github.com/jurajmajer/enrico)) or Managed
- **Privacy**: ⚫ No Policy Available
---
### TFL Status
@ -373,6 +434,13 @@ Shows real-time tube status of the London Underground. All options are optional.
- Central
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed Instance Only
- **Privacy**: _See [TFL Privacy Policy](https://tfl.gov.uk/corporate/privacy-and-cookies/)_
---
### Exchange Rates
@ -403,6 +471,13 @@ Display current FX rates in your native currency
- KPW
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan (upto 100,000 requests/ month)
- **Host**: Managed Instance Only
- **Privacy**: _See [ExchangeRateAPI Privacy Policy](https://www.exchangerate-api.com/terms)_
---
### Stock Price History
@ -430,6 +505,13 @@ Shows recent price history for a given publicly-traded stock or share
apiKey: PGUWSWD6CZTXMT8N
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan (upto 500 requests/day)
- **Host**: Managed Instance Only
- **Privacy**: _See [AlphaVantage Privacy Policy](https://www.alphavantage.co/privacy/)_
---
### Joke
@ -456,6 +538,13 @@ Renders a programming or generic joke. Data is fetched from the [JokesAPI](https
category: Programming
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed Instance or Self-Hosted (see [Sv443/JokeAPI](https://github.com/Sv443/JokeAPI))
- **Privacy**: _See [SV443's Privacy Policy](https://sv443.net/privacypolicy/en)_
---
### News Headlines
@ -484,6 +573,13 @@ Displays the latest news, click to read full article. Date is fetched from vario
category: world
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan (upto 600 requests / day)
- **Host**: Managed Instance Only
- **Privacy**: _See [CurrentsAPI Privacy Policy](https://currentsapi.services/privacy)_
---
### Flight Data
@ -512,6 +608,13 @@ Displays airport departure and arrival flights, using data from [AeroDataBox](ht
direction: all
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan (upto 150 requests / month)
- **Host**: Managed Instance Only
- **Privacy**: _See [AeroDataBox](https://www.aerodatabox.com/#h.p_CXtIYZWF_WQd) and [RapidAPI Policy](https://rapidapi.com/privacy/)_
---
### Astronomy Picture of the Day
@ -530,6 +633,13 @@ _No config options._
- type: apod
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed Instance or Self-Hosted (see [PawelPleskaczynski/apod_api](https://github.com/PawelPleskaczynski/apod_api))
- **Privacy**: _See [NASA's Privacy Policy](https://www.nasa.gov/about/highlights/HP_Privacy.html)_
---
### GitHub Trending
@ -555,6 +665,13 @@ Displays currently trending projects on GitHub. Optionally specify a language an
since: weekly
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed Instance or Self-Hosted (see [Lissy93/gh-trending-no-cors](https://github.com/Lissy93/gh-trending-no-cors))
- **Privacy**: _See [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement)_
---
### GitHub Profile Stats
@ -587,6 +704,13 @@ Display stats from your GitHub profile, using embedded cards from [anuraghazra/g
- lissy93/twitter-sentiment-visualisation
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Managed Instance or Self-Hosted (see [anuraghazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats))
- **Privacy**: _See [GitHub's Privacy Policy](https://docs.github.com/en/github/site-policy/github-privacy-statement)_
---
### Public IP
@ -605,6 +729,13 @@ _No config options._
- type: public-ip
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟠 Optional
- **Price**: 🟢 Free
- **Host**: Managed Instance Only
- **Privacy**: _See [IP-API Privacy Policy](https://ip-api.com/docs/legal)_
---
## Self-Hosted Services Widgets
@ -626,6 +757,9 @@ _No config options._
- type: system-info
```
##### Info
No external data requests made
---
### Cron Monitoring (Health Checks)
@ -649,6 +783,13 @@ Cron job monitoring using [Health Checks](https://github.com/healthchecks/health
apiKey: XXXXXXXXX
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟠 Free plan (upto 20 services, or self-host for unlimited)
- **Host**: Managed Instance or Self-Hosted (see [GitHub - HealthChecks](https://github.com/healthchecks/healthchecks))
- **Privacy**: _See [Health-Checks Privacy Policy](https://healthchecks.io/privacy/)_
---
### CPU History (NetData)
@ -673,6 +814,16 @@ Pull recent CPU usage history from NetData.
host: http://192.168.1.1:19999
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - NetData](https://github.com/netdata/netdata))
- **Privacy**: _See [NetData Privacy Policy](https://www.netdata.cloud/data-privacy/)_
---
### Memory History (NetData)
Pull recent system RAM usage from NetData, and show as a breakdown of different categories.
@ -695,6 +846,13 @@ Pull recent system RAM usage from NetData, and show as a breakdown of different
host: http://192.168.1.1:19999
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - NetData](https://github.com/netdata/netdata))
- **Privacy**: _See [NetData Privacy Policy](https://www.netdata.cloud/data-privacy/)_
---
### Load History (NetData)
@ -719,6 +877,13 @@ Pull recent load usage in 1, 5 and 15 minute intervals, from NetData.
host: http://192.168.1.1:19999
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - NetData](https://github.com/netdata/netdata))
- **Privacy**: _See [NetData Privacy Policy](https://www.netdata.cloud/data-privacy/)_
---
### Pi Hole Stats
@ -741,6 +906,14 @@ Displays the number of queries blocked by [Pi-Hole](https://pi-hole.net/).
options:
hostname: http://192.168.130.1
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - Pi-hole](https://github.com/pi-hole/pi-hole))
- **Privacy**: _See [Pi-Hole Privacy Guide](https://pi-hole.net/privacy/)_
---
### Pi Hole Queries
@ -766,6 +939,13 @@ Shows top queries that were blocked and allowed by [Pi-Hole](https://pi-hole.net
apiKey: xxxxxxxxxxxxxxxxxxxxxxx
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🔴 Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - Pi-hole](https://github.com/pi-hole/pi-hole))
- **Privacy**: _See [Pi-Hole Privacy Guide](https://pi-hole.net/privacy/)_
---
### Recent Traffic
@ -788,6 +968,13 @@ Shows number of recent traffic, using allowed and blocked queries from [Pi-Hole]
hostname: https://pi-hole.local
```
##### Info
- **CORS**: 🟢 Enabled
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - Pi-hole](https://github.com/pi-hole/pi-hole))
- **Privacy**: _See [Pi-Hole Privacy Guide](https://pi-hole.net/privacy/)_
---
### Stat Ping Statuses
@ -810,6 +997,13 @@ Displays the current and recent uptime of your running services, via a self-host
hostname: http://192.168.130.1:8080
```
##### Info
- **CORS**: 🟠 Proxied
- **Auth**: 🟢 Not Required
- **Price**: 🟢 Free
- **Host**: Self-Hosted (see [GitHub - StatPing](https://github.com/statping/statping))
- **Privacy**: _See [StatPing Docs](https://docs.statping.com/)_
---
## Dynamic Widgets