Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Continuous status checking #52

Merged
merged 5 commits into from
Jun 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/status-indicators.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,17 @@ sections:
statusCheck: true
```

## Continuous Checking
By default, with status indicators enabled Dashy will check an applications status on page load, and will not keep indicators updated. This is usually desirable behavior. However, if you do want the status indicators to continue to poll your running services, this can be enabled by setting the `statusCheckInterval` attribute. Here you define an interval in seconds, and Dashy will poll your apps every x seconds. Note that if this number is very low (below 5 seconds), you may notice the app running slightly slower.

The following example, will instruct Dashy to continuously check the status of your services every 20 seconds

```
appConfig:
statusCheck: true
statusCheckInterval: 20
```

## How it Works

When Dashy is loaded, items with `statusCheck` enabled will make a request, to `https://[your-host-name]/ping?url=[address-or-servce]`, which in turn will ping that running service, and respond with a status code. Response time is calculated from the difference between start and end time of the request.
Expand Down
5 changes: 5 additions & 0 deletions src/components/LinkItems/Item.vue
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ export default {
},
itemSize: String,
enableStatusCheck: Boolean,
statusCheckInterval: Number,
},
data() {
return {
Expand Down Expand Up @@ -114,6 +115,7 @@ export default {
}
},
checkWebsiteStatus() {
this.statusResponse = undefined;
const baseUrl = process.env.VUE_APP_DOMAIN || window.location.origin;
const endpoint = `${baseUrl}/ping?url=${this.url}`;
axios.get(endpoint)
Expand All @@ -131,6 +133,9 @@ export default {
mounted() {
this.manageTitleEllipse();
if (this.enableStatusCheck) this.checkWebsiteStatus();
if (this.statusCheckInterval > 0) {
setInterval(this.checkWebsiteStatus, this.statusCheckInterval * 1000);
}
},
};
</script>
Expand Down
8 changes: 8 additions & 0 deletions src/components/LinkItems/ItemGroup.vue
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
:backgroundColor="item.backgroundColor"
:itemSize="newItemSize"
:enableStatusCheck="shouldEnableStatusCheck(item.statusCheck)"
:statusCheckInterval="getStatusCheckInterval()"
@itemClicked="$emit('itemClicked')"
@triggerModal="triggerModal"
/>
Expand Down Expand Up @@ -98,6 +99,13 @@ export default {
const globalPreference = this.config.appConfig.statusCheck || false;
return itemPreference !== undefined ? itemPreference : globalPreference;
},
getStatusCheckInterval() {
let interval = this.config.appConfig.statusCheckInterval;
if (!interval) return 0;
if (interval > 60) interval = 60;
if (interval < 1) interval = 0;
return interval;
},
},
};
</script>
Expand Down
1 change: 1 addition & 0 deletions src/components/Settings/SettingsContainer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ export default {
position: relative;
flex: 1;
background: var(--settings-background);
border-radius: var(--curve-factor-navbar);
}
.options-container {
display: flex;
Expand Down
90 changes: 89 additions & 1 deletion src/styles/color-themes.scss
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,7 @@ html[data-theme='material-original'] {
--heading-text-color: #fff;
--status-check-tooltip-background: #f2f2f2;
--status-check-tooltip-color: #01579b;
--login-form-background: #fff;
}

html[data-theme='material-dark-original'] {
Expand Down Expand Up @@ -250,7 +251,7 @@ html[data-theme='colorful'] {
}
}

html[data-theme='minimal-light'], html[data-theme='minimal-dark'] {
html[data-theme='minimal-light'], html[data-theme='minimal-dark'], html[data-theme='vaporware'] {
--font-body: 'PTMono-Regular', 'Courier New', monospace;
--font-headings: 'PTMono-Regular', 'Courier New', monospace;
label.lbl-toggle h3 {
Expand Down Expand Up @@ -443,6 +444,7 @@ html[data-theme='material'] {
--search-container-background: #4285f4;
--welcome-popup-text-color: #f5f5f5;
--footer-text-color: #f5f5f5cc;
// --login-form-background-secondary: #f5f5f5cc;

header {
background: #4285f4;
Expand Down Expand Up @@ -504,6 +506,8 @@ html[data-theme='material-dark'] {
--scroll-bar-color: #08B0BB;
--scroll-bar-background: #131a1f;
--status-check-tooltip-color: #131a1f;
// --login-form-color: #131a1f;
--login-form-background-secondary: #131a1f;

&::-webkit-scrollbar-thumb {
border-left: 1px solid #131a1f;
Expand Down Expand Up @@ -536,6 +540,7 @@ html[data-theme='minimal-light'] {
--curve-factor-navbar: 8px;
--status-check-tooltip-background: #f2f2f2;
--status-check-tooltip-color: #000;
--login-form-color: #101931;

section.filter-container {
background: #fff;
Expand Down Expand Up @@ -579,4 +584,87 @@ html[data-theme='minimal-dark'] {
border: 1px solid #fff;
}
}
}

html[data-theme='vaporware'] {
--primary: #09bfe6;
--background: #100e2c;
--background-darker: #6c27ea;
--background-darker: linear-gradient(0deg, rgba(108,39,234,1) 0%, rgba(132,76,235,1) 80%);
--settings-text-color: #6c27ea;
--item-group-outer-background: #096de6;
--item-group-outer-background: linear-gradient(45deg, rgba(9,109,230,1) 0%, rgba(9,147,230,1) 50%, rgba(9,109,230,1) 100%);
--item-group-background: #190e2c;
--item-group-heading-text-color: var(--white);
--item-group-heading-text-color-hover: #5118b9;
--item-text-color: #5118b9;
--item-background: #09bfe6;
--item-background-hover: #9967f6;
--footer-text-color: var(--white);
--item-shadow: none;
--curve-factor: 2px;
--curve-factor-navbar: 6px;
--login-form-color: #09bfe6;

.home {
background: linear-gradient(180deg, rgba(16,14,44,1) 10%, rgba(27,24,79,1) 40%, rgba(16,14,44,1) 100%);
}

div.item-group-container {
gap: 0.3rem;
margin: 1rem auto;
}
div.collapsable {
margin: 0.2rem;
padding: 0.2rem;
}
div.content-inner {
padding: 0 !important;
}
a.item {
margin: 0.1rem;
border: 0;
&.size-medium {
min-height: 80px;
}
}
section.filter-container {
background: linear-gradient(0deg, var(--background) 25%, #6c27ea 100%);
form {
background: #6c27ea;
height: 2.5rem;
}
form label, i.clear-search {
color: #100e2c;
border-color: #100e2c;
font-weight: bold;
}
}
.tile-title span.text {
font-weight: normal;
}
label.lbl-toggle h3 {
font-size: 1.4rem;
}
footer {
color: var(--white);
}
a.item {
background: linear-gradient(45deg, rgba(9,191,230,1) 0%, rgba(9,191,230,1) 80%, rgba(9,203,230,1) 100%);
&:hover {
background: #844ceb;
color: #09bfe6;
}
.tile-title span.text { transition: none; }
}

div.login-page {
background: url('https://i.ibb.co/JqcJcGK/vaporwave-sunset-wallpaper.jpg');
background-size: cover;
}
// body {
// background: url('https://i.ibb.co/JqcJcGK/vaporwave-sunset-wallpaper.jpg');
// background-size: cover;
// div.home { background: none; }
// }
}
5 changes: 5 additions & 0 deletions src/utils/ConfigSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,11 @@
"default": false,
"description": "Displays an online/ offline status for each of your services"
},
"statusCheckInterval": {
"type": "number",
"default": 0,
"description": "How often to recheck statuses. If set to 0, status will only be checked on page load"
},
"auth": {
"type": "array",
"description": "Usernames and hashed credentials for frontend authentication",
Expand Down
1 change: 1 addition & 0 deletions src/utils/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module.exports = {
'tiger',
'material-original',
'material-dark-original',
'vaporware',
'high-contrast-dark',
'high-contrast-light',
],
Expand Down
13 changes: 7 additions & 6 deletions src/views/Login.vue
Original file line number Diff line number Diff line change
Expand Up @@ -93,19 +93,20 @@ export default {

.login-field input {
color: var(--login-form-color);
border-color: var(--login-form-background-secondary);
background: var(--login-form-background-secondary);
border-color: var(--login-form-color);
background: var(--login-form-background);
&:focus {

}
}
Button.login-button {
background: var(--login-form-background-secondary);
border-color: var(--login-form-background-secondary);
background: var(--login-form-color);
border-color: var(--login-form-background);
color: var(--login-form-background);
&:hover {
color: var(--login-form-color);
border-color: var(--login-form-color);
color: var(--login-form-background-secondary);
background: var(--login-form-color);
background: var(--login-form-background);
}
&:active, &:focus {
box-shadow: 1px 1px 6px var(--login-form-color);
Expand Down