mirror of
https://github.com/Lissy93/dashy.git
synced 2024-12-23 17:03:59 +03:00
⚠️ Fixes merge conflicts
This commit is contained in:
Alicia Sykes
commit
b24d2ff3d3
20
.github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/add-your-dashboard-to-the-showcase----.md
vendored
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
name: "Add your Dashboard to the Showcase \U0001F5BC️"
|
||||
about: Share a screenshot of your dashboard to the Readme showcase!
|
||||
title: "[SHOWCASE_REQUEST]"
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
Please read the instructions here first:
|
||||
https://github.com/Lissy93/dashy/blob/master/docs/showcase.md#submitting-your-dashboard
|
||||
|
||||
### Complete the Following
|
||||
- **Title of Dashboard**:
|
||||
- **Link to Screenshot**:
|
||||
- **Would you like your name/ username included**: Yes/ No
|
||||
- **Link to your Website/ Profile/ Twitter** (optional)
|
||||
- **Description** (optional)
|
||||
|
||||
Either attach your screenshot here, or include a link to the CDN / image hosting service.
|
||||
23
.github/pull_request_template.md
vendored
23
.github/pull_request_template.md
vendored
@ -1,27 +1,20 @@
|
||||
**Thank you for contributing to Dashy! So that your PR can be handled effectively, please populate the following fields (delete sections that are not applicable)**
|
||||
*Thank you for contributing to Dashy! So that your PR can be handled effectively, please populate the following fields (delete sections that are not applicable)*
|
||||
|
||||
### Category
|
||||
> Please indicate the type of change your PR introduces
|
||||
**Category**:
|
||||
> One of: Bugfix / Feature / Code style update / Refactoring Only / Build related changes / Documentation / Other (please specify)
|
||||
|
||||
Bugfix / Feature / Code style update / Refactoring Only / Build related changes / Documentation / Other (please specify)
|
||||
|
||||
|
||||
### Overview
|
||||
**Overview**
|
||||
> Briefly outline your new changes...
|
||||
|
||||
**Issue Number** _(if applicable)_ #00
|
||||
|
||||
### Issue Number _(if applicable)_
|
||||
#00
|
||||
|
||||
### New Vars _(if applicable)_
|
||||
**New Vars** _(if applicable)_
|
||||
> If you've added any new build scripts, environmental variables, config file options, dependency or devDependency, please outline here
|
||||
|
||||
|
||||
### Screenshot _(if applicable)_
|
||||
**Screenshot** _(if applicable)_
|
||||
> If you've introduced any significant UI changes, please include a screenshot
|
||||
|
||||
|
||||
### Code Quality Checklist _(Please complete)_
|
||||
**Code Quality Checklist** _(Please complete)_
|
||||
- [ ] All changes are backwards compatible
|
||||
- [ ] All lint checks and tests are passing
|
||||
- [ ] There are no (new) build warnings or errors
|
||||
|
||||
119
README.md
119
README.md
@ -9,40 +9,47 @@
|
||||
[](https://github.com/awesome-selfhosted/awesome-selfhosted#personal-dashboards)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Features 🌈
|
||||
|
||||
- Instant search by name, domain and tags - just start typing
|
||||
- Full keyboard shortcuts for navigation, searching and launching
|
||||
- Multiple color themes, with easy method for adding more
|
||||
- Customizable layout options, and item sizes
|
||||
- Quickly preview a website, by holding down the Alt key while clicking, to open it in a resizable pop-up modal
|
||||
- Easy to customize every part of your dashboard, layout, icon sizes and colors etc
|
||||
- Many options for icons, including full Font-Awesome support and the ability to auto-fetch icon from URLs favicon
|
||||
- Option to show service status for each of your apps / links, for basic availability and uptime monitoring
|
||||
- Additional info for each item visible on hover (including opening method icon and description as a tooltip)
|
||||
- Option for full-screen background image, custom nav-bar links, and custom footer text
|
||||
- Multiple ways of opening apps, either in your browser, a pop-up modal or workspace view
|
||||
- Option for full-screen background image, custom nav-bar links, html footer, title, and more
|
||||
- Encrypted cloud backup and restore feature available
|
||||
- Optional authentication, requiring user to log in
|
||||
- Easy single-file YAML-based configuration
|
||||
- Small bundle size, fully responsive UI and PWA makes the app easy to use on any device
|
||||
- Plus lots more...
|
||||
|
||||
**Live Demos**: [Demo 1](https://dashy-demo-1.as93.net) ┆ [Demo 2](https://dashy-demo-2.as93.net) ┆ [Demo 3](https://dashy-demo-3.as93.net)
|
||||
## Demo ⚡
|
||||
|
||||
**Spin up your own demo**: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
> For more examples of Dashy in action, see: [**The Showcase**](./docs/showcase.md)
|
||||
|
||||
**Screenshots**
|
||||
|
||||
#### Live Demos
|
||||
[Demo 1](https://dashy-demo-1.as93.net) ┆ [Demo 2](https://dashy-demo-2.as93.net) ┆ [Demo 3](https://dashy-demo-3.as93.net)
|
||||
|
||||
**Recording**
|
||||
#### Spin up your own Demo
|
||||
- 1-Click Deploy: [](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
- Or on your own machine: `docker run -p 8080:80 lissy93/dashy`
|
||||
|
||||
#### Recording
|
||||
<p align="center">
|
||||
<img width="800" src="https://i.ibb.co/L8YbNNc/dashy-demo2.gif" alt="Demo">
|
||||
</p>
|
||||
|
||||
#### User Showcase
|
||||
Are using Dashy? Want to share your dashboard here too - [Submit your Screenshots to the Showcase](./docs/showcase.md#submitting-your-dashboard)!
|
||||
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
@ -69,8 +76,8 @@ docker run -d \
|
||||
--restart=always \
|
||||
lissy93/dashy:latest
|
||||
```
|
||||
Healthchecks are pre-configured to monitor the uptime and response times of Dashy, and the status of which can be seen in the container logs, e.g. `docker inspect --format "{{json .State.Health }}" [container-id]`.
|
||||
|
||||
You can also build the Docker container from source, by cloning the repo, cd'ing into it and running `docker build .` and `docker compose up`.
|
||||
#### Deploying from Source 🚀
|
||||
|
||||
You will need both [git](https://git-scm.com/downloads) and the latest or LTS version of [Node.js](https://nodejs.org/) installed on your system
|
||||
@ -83,18 +90,15 @@ You will need both [git](https://git-scm.com/downloads) and the latest or LTS ve
|
||||
|
||||
#### Deploy to the Cloud
|
||||
|
||||
Dashy supports 1-Click deployments on several popular cloud platforms (with more on the way!). To get started, just click a link below:
|
||||
Dashy supports 1-Click deployments on several popular cloud platforms. To get started, just click a link below:
|
||||
- [Deploy to Netlify](https://app.netlify.com/start/deploy?repository=https://github.com/lissy93/dashy)
|
||||
- [Deploy to Heroku](https://heroku.com/deploy?template=https://github.com/Lissy93/dashy)
|
||||
- [Deploy with Vercel](https://vercel.com/new/project?template=https://github.com/lissy93/dashy)
|
||||
- [Deploy with PWD](https://labs.play-with-docker.com/?stack=https://raw.githubusercontent.com/Lissy93/dashy/master/docker-compose.yml)
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
#### Basic Commands
|
||||
|
||||
The following commands can be run on Dashy. If you are using Docker, than precede each command with `docker exec -it [container-id]`, where container id can be found by running `docker ps`, e.g. `docker exec -it 92490c12baff yarn build`.
|
||||
If you prefer [`NPM`](https://docs.npmjs.com), then just replace `yarn` with `npm run` in the following commands.
|
||||
The following commands can be run on Dashy.
|
||||
|
||||
- `yarn build` - Builds the project for production, and outputs it into `./dist`
|
||||
- `yarn start` - Starts a web server, and serves up the production site from `./dist`
|
||||
@ -106,6 +110,13 @@ If you prefer [`NPM`](https://docs.npmjs.com), then just replace `yarn` with `np
|
||||
- `yarn test` - Runs tests, and outputs results
|
||||
- `yarn install` - Install all dependencies
|
||||
|
||||
If you are using Docker, than precede each command with `docker exec -it [container-id]`, where container id can be found by running `docker ps`, e.g. `docker exec -it 92490c12baff yarn build`.
|
||||
If you prefer [`NPM`](https://docs.npmjs.com), then just replace `yarn` with `npm run` in the following commands.
|
||||
|
||||
In Docker, [healthchecks](https://docs.docker.com/engine/reference/builder/#healthcheck) are pre-configured to monitor the uptime and response times of Dashy, and the status of which will show in your Docker monitoring app, or the `docker ps` command, or the container logs, using: `docker inspect --format "{{json .State.Health }}" [container-id]`.
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Configuring 🔧
|
||||
@ -118,7 +129,7 @@ In the production environment, the app needs to be rebuilt in order for changes
|
||||
|
||||
You can check that your config matches Dashy's [schema](https://github.com/Lissy93/dashy/blob/master/src/utils/ConfigSchema.json) before deploying, by running `yarn validate-config.`
|
||||
|
||||
It is now possible to update Dashy's config directly through the UI, and have changes written to disk. You can disable this feature by setting: `appConfig.allowConfigEdit: false`. If you are using users within Dashy, then you need to be logged in to a user of `type: admin` in order to modify the configuration globally. You can also trigger a rebuild of the app through the UI (Settings --> Rebuild). The current theme, and other visual preferences are only stored locally, unless otherwise specified in the config file. The option to only apply config changes locally is still available, and can be used in conjunction with the cloud backup feature to sync data between instances.
|
||||
It is now possible also possible to update Dashy's config directly through the UI, and have changes written to disk. You can disable this feature by setting: `appConfig.allowConfigEdit: false`. If you are using users within Dashy, then you need to be logged in to a user of `type: admin` in order to modify the configuration globally. You can also trigger a rebuild of the app through the UI (Settings --> Rebuild).
|
||||
|
||||
You may find these [example config](https://gist.github.com/Lissy93/000f712a5ce98f212817d20bc16bab10) helpful for getting you started
|
||||
|
||||
@ -132,7 +143,7 @@ You may find these [example config](https://gist.github.com/Lissy93/000f712a5ce9
|
||||
|
||||
<p align="center">
|
||||
<a href="https://i.ibb.co/BVSHV1v/dashy-themes-slideshow.gif">
|
||||
<img alt="Example Themes" src="/docs/assets/theme-slideshow.gif" width="400">
|
||||
<img alt="Example Themes" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/theme-slideshow.gif" width="400">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@ -157,6 +168,7 @@ Both sections and items can have an icon associated with them, and defined under
|
||||
- **Favicon**: Set `icon: favicon` to fetch a services icon automatically from the URL of the corresponding application
|
||||
- **Font-Awesome**: To use any font-awesome icon, specify the category, followed by the icon name, e.g. `fas fa-rocket` or `fab fa-monero`. You can also use Pro icons if you have a license key, just set it under `appConfig.fontAwesomeKey`
|
||||
- **Generative**: Setting `icon: generative`, will generate a unique for a given service, based on it's URL or IP
|
||||
- **Emoji**: Use an emoji as a tile icon, by putting the emoji's code as the icon attribute. Emojis can be specified either as emojis (`🚀`), unicode (`'U+1F680'`) or shortcode (`':rocket:'`).
|
||||
- **URL**: You can also pass in a URL to an icon asset, hosted either locally or using any CDN service. E.g. `icon: https://i.ibb.co/710B3Yc/space-invader-x256.png`.
|
||||
- **Local Image**: To use a local image, store it in `./public/item-icons/` (or create a volume in Docker: `-v /local/image/directory:/app/public/item-icons/`) , and reference it by name and extension - e.g. set `icon: image.png` to use `./public/item-icon/image.png`. You can also use sub-folders here if you have a lot of icons, to keep them organized.
|
||||
|
||||
@ -200,10 +212,51 @@ At present, access control is handled on the frontend, and therefore in security
|
||||
|
||||
> For full monitoring documentation, see: [**Status Indicators**](./docs/status-indicators.md)
|
||||
|
||||
Dashy has an optional feature that can display a small icon ([like this](./docs/assets/status-check-demo.gif)) next to each of your running services, indicating it's current status. This is useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. Hovering over the indicator will show additional information, including average response time and an error message for services which are down.
|
||||
Dashy has an optional feature that can display a small icon next to each of your running services, indicating it's current status. This is useful if you are using Dashy as your homelab's start page, as it gives you an overview of the health of each of your running services. Hovering over the indicator will show additional information, including average response time and an error message for services which are down.
|
||||
|
||||
By default, this feature is off, but you can enable it globally by setting `appConfig.statusCheck: true`, or enable/ disable it for an individual item, with `item[n].statusCheck`. You can also specify an time interval in seconds under `appConfig.statusCheckInterval`, which will determine how often to recheck services, if this value is `0`, then status is only checked on initial page load, this is default behavior.
|
||||
|
||||
<p align="center">
|
||||
<img alt="Status Checks demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif" width="600">
|
||||
</p>
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Opening Methods 🖱️
|
||||
|
||||
One of the primary purposes of Dashy is to make launching commonly used apps and services as quick as possible. To aid in this, there are several different options on how items can be opened. You can configure your preference by setting the `target` property of any item, to one of the following values:
|
||||
- `sametab` - The app will be launched in the current tab
|
||||
- `newtab` - The app will be launched in a new tab
|
||||
- `modal` - Launch app in a resizable/ movable popup modal on the current page
|
||||
- `workspace` - Changes to Workspace view, and launches app
|
||||
|
||||
Even if the target is not set (or is set to `sametab`), you can still launch any given app in an alternative method: Alt + Click will open the modal, and Ctrl + Click will open in a new tab. You can also right-click on any item to see all options (as seen in the screenshot below). This custom context menu can be disabled by setting `appConfig.disableContextMenu: true`.
|
||||
|
||||
<p align="center">
|
||||
<img width="500" src="https://i.ibb.co/vmZdSRt/dashy-context-menu-2.png" />
|
||||
</p>
|
||||
|
||||
The modal and workspace views work by rendering the target application in an iframe. For this to work, the HTTP response header [`X-Frame-Options`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options) for a given application needs to be set to `ALLOW`. If you are getting a `Refused to Connect` error then this header is set to `DENY` (or `SAMEORIGIN` and it's on a different host).
|
||||
|
||||
Here's a quick demo of the workspace view:
|
||||
<p align="center">
|
||||
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/workspace-demo.gif" width="600">
|
||||
</p>
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Config Editor ⚙️
|
||||
|
||||
From the Settings Menu in Dashy, you can download, backup, edit and rest your config. An interactive editor makes editing the config file easy, it will tell you if you've got any errors. After making your changes, you can either apply them locally, or export into your main config file. After saving to the config file to the disk, the app will need to be rebuilt. This will happen automatically, but may take a few minutes. You can also manually trigger a rebuild from the Settings Menu. A full list of available config options can be found [here](./docs/configuring.md). It's recommend to make a backup of your configuration, as you can then restore it into a new instance of Dashy, without having to set it up again. [json2yaml](https://www.json2yaml.com/) is very useful for converting between YAML to JSON and visa versa.
|
||||
|
||||
<p align="center">
|
||||
<img alt="Workspace view demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/config-editor-demo.gif" width="600">
|
||||
</p>
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
@ -230,7 +283,7 @@ If you are new to Vue.js or web development and want to learn more, [here are so
|
||||
|
||||
Pull requests are welcome, and would by much appreciated!
|
||||
|
||||
Some ideas for PRs include: bug fixes, improve the docs, add new themes, implement a new widget, add or improve the display options, improve or refactor the code, or implement a new feature.
|
||||
Some ideas for PRs include: bug fixes, improve the docs, submit a screenshot of your dashboard to the showcase, add new themes, implement a new widget, add or improve the display options, improve or refactor the code, or implement a new feature.
|
||||
|
||||
Before you submit your pull request, please ensure the following:
|
||||
- Must be backwards compatible
|
||||
@ -240,18 +293,12 @@ Before you submit your pull request, please ensure the following:
|
||||
- Your pull request will need to be up-to-date with master, and the PR template must be filled in
|
||||
|
||||
### Repo Status
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
@ -268,6 +315,9 @@ If you've found a bug, or something that isn't working as you'd expect, please r
|
||||
- [Ask a Question 🤷♀️](https://github.com/Lissy93/dashy/issues/new?assignees=Lissy93&labels=%F0%9F%A4%B7%E2%80%8D%E2%99%82%EF%B8%8F+Question&template=question------.md&title=%5BQUESTION%5D)
|
||||
- [Share Feedback 🌈](https://github.com/Lissy93/dashy/issues/new?assignees=&labels=%F0%9F%8C%88+Feedback&template=share-feedback---.md&title=%5BFEEDBACK%5D)
|
||||
|
||||
[**Issue Status**](https://isitmaintained.com/project/lissy93/dashy)   
|
||||
|
||||
|
||||
For more general questions about any of the technologies used, [StackOverflow](https://stackoverflow.com/questions/) may be more helpful first port of info
|
||||
|
||||
If you need to get in touch securely with the author (me, Alicia Sykes), drop me a message at:
|
||||
@ -280,16 +330,18 @@ For more general questions about any of the technologies used, [StackOverflow](h
|
||||
|
||||
## Documentation 📘
|
||||
|
||||
- [Getting Started](/docs/deployment.md)
|
||||
- [Deployment](/docs/deployment.md)
|
||||
- [Configuring](/docs/configuring.md)
|
||||
- [Developing](/docs/developing.md)
|
||||
- [Contributing](/docs/contributing.md)
|
||||
- [User Guide](/docs/user-guide.md)
|
||||
- [Troubleshooting](/docs/troubleshooting.md)
|
||||
- [Backup & Restore](/docs/backup-restore.md)
|
||||
- [Status Indicators](/docs/status-indicators.md)
|
||||
- [Theming](/docs/theming.md)
|
||||
- [Icons](/docs/icons.md)
|
||||
- [Authentication](/docs/authentication.md)
|
||||
- [Showcase](/docs/showcase.md)
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
@ -332,7 +384,8 @@ The 1-Click deploy demo uses [Play-with-Docker Labs](https://play-with-docker.co
|
||||
|
||||
### Alternatives 🙌
|
||||
|
||||
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out! Including, but not limited to: [HomeDash2](https://lamarios.github.io/Homedash2), [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`), [Organizr](https://organizr.app/) (`GPL-3.0 License`) and [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
|
||||
There are a few self-hosted web apps, that serve a similar purpose to Dashy. If you're looking for a dashboard, and Dashy doesn't meet your needs, I highly recommend you check these projects out!
|
||||
[HomeDash2](https://lamarios.github.io/Homedash2), [Homer](https://github.com/bastienwirtz/homer) (`Apache License 2.0`), [Organizr](https://organizr.app/) (`GPL-3.0 License`) and [Heimdall](https://github.com/linuxserver/Heimdall) (`MIT License`)
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
@ -362,8 +415,8 @@ OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
**TDLR;** _You can do whatever you like with Dashy: use it in private or commercial settings,_
|
||||
_redistribute and modify it. But you must display this license and credit the author._
|
||||
_There is no warranty that this app will work as expected, and the author cannot be held_
|
||||
_liable for anything that goes wrong._ For more info, see
|
||||
[TLDR Legal's MIT Explanation of the MIT License](https://tldrlegal.com/license/mit-license)
|
||||
_liable for anything that goes wrong._
|
||||
For more info, see TLDR Legal's [Explanation of MIT](https://tldrlegal.com/license/mit-license)
|
||||
|
||||
|
||||
|
||||
|
||||
BIN
docs/assets/config-editor-demo.gif
Normal file
BIN
docs/assets/config-editor-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
BIN
docs/assets/workspace-demo.gif
Normal file
BIN
docs/assets/workspace-demo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.8 MiB |
@ -1,4 +1,4 @@
|
||||
## Configuring
|
||||
# Configuring
|
||||
|
||||
All app configuration is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) which is in [YAML Format](https://yaml.org/) format.
|
||||
|
||||
@ -11,17 +11,17 @@ There's a couple of things to remember, before getting started:
|
||||
- You can check that your config file fits the schema, by running `yarn validate-config`
|
||||
- Any which are only saved locally through the UI need to be exported into this file, in order for them to persist across devices
|
||||
|
||||
#### Config Saving Methods
|
||||
### Config Saving Methods
|
||||
When updating the config through the JSON editor in the UI, you have two save options: **Local** or **Write to Disk**. Changes saved locally will only be applied to the current user through the browser, and to apply to other instances, you either need to use the cloud sync feature, or manually update the conf.yml file. On the other-hand, if you choose to write changes to disk, then your main `conf.yml` file will be updated, and changes will be applied to all users, and visible across all devices.
|
||||
|
||||
#### Preventing Changes being Written to Disk
|
||||
### Preventing Changes being Written to Disk
|
||||
To disallow any changes from being written to disk, then set `appConfig.allowConfigEdit: false`. If you are using users, and have setup `auth` within Dashy, then only users with `type: admin` will be able to write config changes to disk.
|
||||
|
||||
It is recommended to make a backup of your config file.
|
||||
|
||||
All fields are optional, unless otherwise stated.
|
||||
|
||||
#### Top-Level Fields
|
||||
### Top-Level Fields
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -31,7 +31,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `PageInfo`
|
||||
### `PageInfo`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -42,7 +42,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `pageInfo.navLinks` _(optional)_
|
||||
### `pageInfo.navLinks` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -51,7 +51,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `appConfig` _(optional)_
|
||||
### `appConfig` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -61,6 +61,7 @@ All fields are optional, unless otherwise stated.
|
||||
**`enableFontAwesome`** | `boolean` | _Optional_ | Where `true` is enabled, if left blank font-awesome will be enabled only if required by 1 or more icons
|
||||
**`fontAwesomeKey`** | `string` | _Optional_ | If you have a font-awesome key, then you can use it here and make use of premium icons. It is a 10-digit alpha-numeric string from you're FA kit URL (e.g. `13014ae648`)
|
||||
**`faviconApi`** | `string` | _Optional_ | Which service to use to resolve favicons. Set to `local` to do this locally, without using an API. Available options are: `local`, `faviconkit`, `google`, `clearbit`, `webmasterapi` and `allesedv`. Defaults to `faviconkit`. See [Icons](/docs/icons.md#favicons) for more info
|
||||
**`auth`** | `array` | _Optional_ | An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. Note authentication is done on the client side, and so if your instance of Dashy is exposed to the internet, it is recommend to configure your web server to handle this. See [`auth`](#appconfigauth-optional)
|
||||
**`layout`** | `string` | _Optional_ | App layout, either `horizontal`, `vertical`, `auto` or `sidebar`. Defaults to `auto`. This specifies the layout and direction of how sections are positioned on the home screen. This can also be modified from the UI.
|
||||
**`iconSize`** | `string` | _Optional_ | The size of link items / icons. Can be either `small`, `medium,` or `large`. Defaults to `medium`. This can also be set directly from the UI.
|
||||
**`theme`** | `string` | _Optional_ | The default theme for first load (you can change this later from the UI)
|
||||
@ -68,13 +69,13 @@ All fields are optional, unless otherwise stated.
|
||||
**`externalStyleSheet`** | `string` or `string[]` | _Optional_ | Either a URL to an external stylesheet or an array or URLs, which can be applied as themes within the UI
|
||||
**`customCss`** | `string` | _Optional_ | Raw CSS that will be applied to the page. This can also be set from the UI. Please minify it first.
|
||||
**`showSplashScreen`** | `boolean` | _Optional_ | Should display a splash screen while the app is loading. Defaults to false, except on first load
|
||||
**`auth`** | `array` | _Optional_ | An array of objects containing usernames and hashed passwords. If this is not provided, then authentication will be off by default, and you will not need any credentials to access the app. Note authentication is done on the client side, and so if your instance of Dashy is exposed to the internet, it is recommend to configure your web server to handle this. See [`auth`](#appconfigauth-optional)
|
||||
**`allowConfigEdit`** | `boolean` | _Optional_ | Should prevent / allow the user to write configuration changes to the conf.yml from the UI. When set to `false`, the user can only apply changes locally using the config editor within the app, whereas if set to `true` then changes can be written to disk directly through the UI. Defaults to `true`. Note that if authentication is enabled, the user must be of type `admin` in order to apply changes globally.
|
||||
**`disableServiceWorker`** | `boolean` | _Optional_ | Service workers cache web applications to improve load times and offer basic offline functionality, and are enabled by default in Dashy. The service worker can sometimes cause older content to be cached, requiring the app to be hard-refreshed. If you do not want SW functionality, or are having issues with caching, set this property to `true` to disable all service workers.
|
||||
**`disableContextMenu`** | `boolean` | _Optional_ | If set to `true`, the custom right-click context menu will be disabled. Defaults to `false`.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `appConfig.auth` _(optional)_
|
||||
### `appConfig.auth` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -84,7 +85,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `section`
|
||||
### `section`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -95,7 +96,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `section.item`
|
||||
### `section.item`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -103,14 +104,16 @@ All fields are optional, unless otherwise stated.
|
||||
**`description`** | `string` | _Optional_ | Additional info about an item, which is shown in the tooltip on hover, or visible on large tiles
|
||||
**`url`** | `string` | Required | The URL / location of web address for when the item is clicked
|
||||
**`icon`** | `string` | _Optional_ | The icon for a given item. Can be a font-awesome icon, favicon, remote URL or local URL. See [`item.icon`](#sectionicon-and-sectionitemicon)
|
||||
**`target`** | `string` | _Optional_ | The opening method for when the item is clicked, either `newtab`, `sametab` or `iframe`. Where `newtab` will open the link in a new tab, `sametab` will open it in the current tab, and `iframe` will open a pop-up modal with the content displayed within that iframe. Note that for the iframe to load, you must have set the CORS headers to either allow `*` ot allow the domain that you are hosting Dashy on, for some websites and self-hosted services, this is already set.
|
||||
**`target`** | `string` | _Optional_ | The opening method for when the item is clicked, either `newtab`, `sametab`, `modal` or `workspace`. Where `newtab` will open the link in a new tab, `sametab` will open it in the current tab, and `modal` will open a pop-up modal with the content displayed within that iframe. Note that for the iframe to load, you must have set the CORS headers to either allow `*` ot allow the domain that you are hosting Dashy on, for some websites and self-hosted services, this is already set.
|
||||
**`statusCheck`** | `boolean` | _Optional_ | When set to `true`, Dashy will ping the URL associated with the current service, and display its status as a dot next to the item. The value here will override `appConfig.statusCheck` so you can turn off or on checks for a given service. Defaults to `appConfig.statusCheck`, falls back to `false`
|
||||
**`statusCheckUrl`** | `string` | _Optional_ | If you've enabled `statusCheck`, and want to use a different URL to what is defined under the item, then specify it here
|
||||
**`statusCheckHeaders`** | `object` | _Optional_ | If you're endpoint requires any specific headers for the status checking, then define them here
|
||||
**`color`** | `string` | _Optional_ | An optional color for the text and font-awesome icon to be displayed in. Note that this will override the current theme and so may not display well
|
||||
**`backgroundColor`** | `string` | _Optional_ | An optional background fill color for the that given item. Again, this will override the current theme and so might not display well against the background
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `section.displayData` _(optional)_
|
||||
### `section.displayData` _(optional)_
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -126,7 +129,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### `section.icon` and `section.item.icon`
|
||||
### `section.icon` and `section.item.icon`
|
||||
|
||||
**Field** | **Type** | **Required**| **Description**
|
||||
--- | --- | --- | ---
|
||||
@ -134,7 +137,7 @@ All fields are optional, unless otherwise stated.
|
||||
|
||||
**[⬆️ Back to Top](#configuring)**
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
||||
@ -3,14 +3,15 @@
|
||||
Both sections and items can have an icon, which is specified using the `icon` attribute. Using icons improves the aesthetics of your UI and makes the app more intuitive to use. There are several options when it comes to setting icons, and this article outlines each of them
|
||||
|
||||
- [Font Awesome Icons](#font-awesome)
|
||||
- [Favicons](#favicons)
|
||||
- [Auto-Fetched Favicons](#favicons)
|
||||
- [Generative Icons](#generative-icons)
|
||||
- [Emoji Icons](#emoji-icons)
|
||||
- [Icons by URL](#icons-by-url)
|
||||
- [Local Icons](#local-icons)
|
||||
- [No Icon](#no-icon)
|
||||
|
||||
<p align="center">
|
||||
<img width="400" src="https://i.ibb.co/GTVmZnc/dashy-example-icons.png" />
|
||||
<img width="500" src="https://i.ibb.co/GTVmZnc/dashy-example-icons.png" />
|
||||
</p>
|
||||
|
||||
### Font Awesome
|
||||
@ -18,10 +19,17 @@ You can use any [Font Awesome Icon](https://fontawesome.com/icons) simply by spe
|
||||
|
||||
Font-Awesome has a wide variety of free icons, but you can also use their pro icons if you have a membership. To do so, you need to specify your license key under: `appConfig.fontAwesomeKey`. This is usually a 10-digit string, for example `13014ae648`.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/pdrw8J4/fontawesome-icons2.png" />
|
||||
</p>
|
||||
|
||||
### Favicons
|
||||
Dashy can auto-fetch the favicon for a given service using it's URL. Just set `icon: favicon` to use this feature. If the services URL is a local IP, then Dashy will attempt to find the favicon from `http://[ip]/favicon.ico`. This has two issues, favicons are not always hosted at the same location for every service, and often the default favicon is a low resolution. Therefore to fix this, for remote services an API is used to return a high-quality icon for any online service.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/k6wyhnB/favicon-icons.png" />
|
||||
</p>
|
||||
|
||||
The default favicon API is [Favicon Kit](https://faviconkit.com/), a free and reliable service for returning images from any given URL. However several other API's are supported. To change the API used, under `appConfig`, set `faviconApi` to one of the following values:
|
||||
|
||||
- `faviconkit` - [faviconkit.com](https://faviconkit.com/) (Recommend)
|
||||
@ -35,6 +43,29 @@ You can also force Dashy to always get favicons from the root of the domain, and
|
||||
### Generative Icons
|
||||
Uses a unique and programmatically generated icon for a given service. This is particularly useful when you have a lot of similar services with a different IP or port, and no specific icon. These icons are generated with [ipsicon.io](https://ipsicon.io/). To use this option, just set an item's to: `icon: generative`.
|
||||
|
||||
<p align="center">
|
||||
<img width="400" src="https://i.ibb.co/qrNNNcm/generative-icons.png" />
|
||||
</p>
|
||||
|
||||
### Emoji Icons
|
||||
You can use almost any emoji as an icon for items or sections. You can specify the emoji either by pasting it directly, using it's unicode ( e.g. `'U+1F680'`) or shortcode (e.g. `':rocket:'`). You can find these codes for any emoji using [Emojipedia](https://emojipedia.org/) (near the bottom of emoji each page), or for a quick reference to emoji shortcodes, check out [emojis.ninja](https://emojis.ninja/) by @nomanoff.
|
||||
|
||||
<p align="center">
|
||||
<img width="580" src="https://i.ibb.co/YLwgTf9/emoji-icons-1.png" />
|
||||
</p>
|
||||
|
||||
The following example shows the unicode options available, all three will render the 🚀 emoji.
|
||||
|
||||
```yaml
|
||||
items:
|
||||
- title: Shortcode
|
||||
icon: ':rocket:'
|
||||
- title: Unicode
|
||||
icon: 'U+1F680'
|
||||
- title: Emoji
|
||||
icon: 🚀
|
||||
```
|
||||
|
||||
### Icons by URL
|
||||
You can also set an icon by passing in a valid URL pointing to the icons location. For example `icon: https://i.ibb.co/710B3Yc/space-invader-x256.png`, this can be in .png, .jpg or .svg format, and hosted anywhere- so long as it's accessible from where you are hosting Dashy. The icon will be automatically scaled to fit, however loading in a lot of large icons may have a negative impact on performance, especially if you visit Dashy from new devices often.
|
||||
|
||||
@ -44,4 +75,4 @@ You may also want to store your icons locally, bundled within Dashy so that ther
|
||||
You can also use sub-folders within the `item-icons` directory to keep things organised. You would then specify an icon with it's folder name slash image name. For example: `networking/monit.png`
|
||||
|
||||
### No Icon
|
||||
If you don't wish for a given item or section to have an icon, just leave out the `icon` attribute.
|
||||
If you don't wish for a given item or section to have an icon, just leave out the `icon` attribute.
|
||||
|
||||
72
docs/showcase.md
Normal file
72
docs/showcase.md
Normal file
@ -0,0 +1,72 @@
|
||||
# *Dashy Showcase* 🌟
|
||||
|
||||
| 💗 Do you use Dashy? Got a sweet dashboard? Submit it to the showcase! 👉 [See How](#submitting-your-dashboard) |
|
||||
|-|
|
||||
|
||||
### Home Lab 2.0
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Networking Services
|
||||
> By [@Lissy93](https://github.com/lissy93)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### NAS Home Dashboard
|
||||
> By [@cerealconyogurt](https://github.com/cerealconyogurt)
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### CFT Toolbox
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Bookmarks
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Project Management
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Submitting your Dashboard
|
||||
|
||||
#### How to Submit
|
||||
- [Open an Issue](https://git.io/Jceik)
|
||||
- [Open a PR](https://github.com/Lissy93/dashy/compare)
|
||||
|
||||
#### What to Include
|
||||
Please include the following information:
|
||||
- A single high-quality screenshot of your Dashboard
|
||||
- A short title (it doesn't have to be particularly imaginative)
|
||||
- An optional description, you could include details on anything interesting or unique about your dashboard, or say how you use it, and why it's awesome
|
||||
- Optionally leave your name or username, with a link to your GitHub, Twitter or Website
|
||||
|
||||
#### Template
|
||||
|
||||
If you're submitting a pull request, please use a format similar to this:
|
||||
|
||||
```
|
||||
### [Dashboard Name] (required)
|
||||
|
||||
> Submitted by [@username](https://github.com/user) (optional)
|
||||
|
||||
 (required)
|
||||
|
||||
[An optional text description, or any interesting details] (optional)
|
||||
|
||||
---
|
||||
|
||||
```
|
||||
BIN
docs/showcase/1-home-lab-material.png
Normal file
BIN
docs/showcase/1-home-lab-material.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 187 KiB |
BIN
docs/showcase/2-networking-services-minimal-dark.png
Normal file
BIN
docs/showcase/2-networking-services-minimal-dark.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/showcase/3-cft-toolbox.png
Normal file
BIN
docs/showcase/3-cft-toolbox.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/showcase/4-bookmarks-colourful.png
Normal file
BIN
docs/showcase/4-bookmarks-colourful.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 137 KiB |
BIN
docs/showcase/5-project-managment.png
Normal file
BIN
docs/showcase/5-project-managment.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 108 KiB |
BIN
docs/showcase/6-nas-home-dashboard.png
Normal file
BIN
docs/showcase/6-nas-home-dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 331 KiB |
@ -48,10 +48,29 @@ appConfig:
|
||||
statusCheckInterval: 20
|
||||
```
|
||||
|
||||
## Using a Different Endpoint
|
||||
By default, the status checker will use the URL of each application being checked. In some situations, you may want to use a different endpoint for status checking. Similarly, some services provide a dedicated path for uptime monitoring.
|
||||
|
||||
You can set the `statusCheckUrl` property on any given item in order to do this. The status checker will then ping that endpoint, instead of the apps main `url` property.
|
||||
|
||||
## Setting Custom Headers
|
||||
If your service is responding with an error, despite being up and running, it is most likely because custom headers for authentication, authorization or encoding are required. You can define these headers under the `statusCheckHeaders` property for any service. It should be defined as an object format, with the name of header as the key, and header content as the value.
|
||||
For example, `statusCheckHeaders: { 'X-Custom-Header': 'foobar' }`
|
||||
|
||||
## Troubleshooting Failing Status Checks
|
||||
If the status is always returning an error, despite the service being online, then it is most likely an issue with access control, and should be fixed with the correct headers. Hover over the failing status to see the error code and response, in order to know where to start with addressing it.
|
||||
If your service requires requests to include any authorization in the headers, then use the `statusCheckHeaders` property, as described above.
|
||||
If you are still having issues, it may be because your target application is blocking requests from Dashy's IP. This is a [CORS error](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS), and can be fixed by setting the headers on your target app, to include:
|
||||
```
|
||||
Access-Control-Allow-Origin: https://location-of-dashy/
|
||||
Vary: Origin
|
||||
```
|
||||
For further troubleshooting, use an application like [Postman](https://postman.com) to diagnose the issue.
|
||||
|
||||
## 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.
|
||||
|
||||
An indicator will display next to each item, and will be yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together.
|
||||
When the response completes, an indicator will display next to each item. The color denotes the status: Yellow while waiting for the response to return, green if request was successful, red if it failed, and grey if it was unable to make the request all together.
|
||||
|
||||
All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns.
|
||||
All requests are made straight from your server, there is no intermediary. So providing you are hosting Dashy yourself, and are checking the status of other self-hosted services, there shouldn't be any privacy concerns. Requests are made asynchronously, so this won't have any impact on page load speeds. However recurring requests (using `statusCheckInterval`) may run more slowly if the interval between requests is very short.
|
||||
|
||||
@ -129,8 +129,9 @@ You can target specific elements on the UI with these variables. All are optiona
|
||||
- `--status-check-tooltip-color` - Text color for the status check tooltips. Defaults to `--primary`
|
||||
- `--code-editor-color` - Text color used within raw code editors. Defaults to `--black`
|
||||
- `--code-editor-background` - Background color for raw code editors. Defaults to `--white`
|
||||
|
||||
|
||||
- `--context-menu-color` - Text color for right-click context menu over items. Defaults to `--primary`
|
||||
- `--context-menu-background` - Background color of right-click context menu. Defaults to `--background`
|
||||
- `--context-menu-secondary-color` - Border and outline color for context menu. Defaults to `--background-darker`
|
||||
|
||||
#### Non-Color Variables
|
||||
- `--outline-color` - Used to outline focused or selected elements
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "Dashy",
|
||||
"version": "1.2.5",
|
||||
"version": "1.3.6",
|
||||
"license": "MIT",
|
||||
"main": "server",
|
||||
"scripts": {
|
||||
@ -86,4 +86,4 @@
|
||||
"> 1%",
|
||||
"last 2 versions"
|
||||
]
|
||||
}
|
||||
}
|
||||
20
src/assets/interface-icons/open-workspace.svg
Normal file
20
src/assets/interface-icons/open-workspace.svg
Normal file
@ -0,0 +1,20 @@
|
||||
<svg
|
||||
aria-hidden="true"
|
||||
focusable="false"
|
||||
data-prefix="far"
|
||||
data-icon="browser"
|
||||
class="svg-inline--fa fa-browser fa-w-16"
|
||||
role="img"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
viewBox="0 0 512 512"
|
||||
>
|
||||
<path
|
||||
transform = "rotate(-90 250 250)"
|
||||
fill="currentColor"
|
||||
d="M464 32H48C21.5 32 0 53.5 0 80v352c0 26.5 21.5 48 48 48h416c26.5 0 48-21.5
|
||||
48-48V80c0-26.5-21.5-48-48-48zM48 92c0-6.6 5.4-12 12-12h40c6.6 0 12 5.4 12
|
||||
12v24c0 6.6-5.4 12-12 12H60c-6.6 0-12-5.4-12-12V92zm416 334c0 3.3-2.7 6-6
|
||||
6H54c-3.3 0-6-2.7-6-6V168h416v258zm0-310c0 6.6-5.4 12-12 12H172c-6.6
|
||||
0-12-5.4-12-12V92c0-6.6 5.4-12 12-12h280c6.6 0 12 5.4 12 12v24z">
|
||||
</path>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 697 B |
@ -42,11 +42,6 @@ export default {
|
||||
components: {
|
||||
Icon,
|
||||
},
|
||||
data() {
|
||||
return {
|
||||
isOpen: !this.collapsed,
|
||||
};
|
||||
},
|
||||
methods: {
|
||||
/* Check that row & column span is valid, and not over the max */
|
||||
checkSpanNum(span, classPrefix) {
|
||||
|
||||
116
src/components/LinkItems/ContextMenu.vue
Normal file
116
src/components/LinkItems/ContextMenu.vue
Normal file
@ -0,0 +1,116 @@
|
||||
<template>
|
||||
<transition name="slide">
|
||||
<div class="context-menu" v-if="show && menuEnabled"
|
||||
:style="posX && posY ? `top:${posY}px;left:${posX}px;` : ''">
|
||||
<ul>
|
||||
<li @click="launch('sametab')">
|
||||
<SameTabOpenIcon />
|
||||
<span>Open in Current Tab</span>
|
||||
</li>
|
||||
<li @click="launch('newtab')">
|
||||
<NewTabOpenIcon />
|
||||
<span>Open in New Tab</span>
|
||||
</li>
|
||||
<li @click="launch('modal')">
|
||||
<IframeOpenIcon />
|
||||
<span>Open in Pop-Up Modal</span>
|
||||
</li>
|
||||
<li @click="launch('workspace')">
|
||||
<WorkspaceOpenIcon />
|
||||
<span>Open in Workspace View</span>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</transition>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
// Import icons for each element
|
||||
import SameTabOpenIcon from '@/assets/interface-icons/open-current-tab.svg';
|
||||
import NewTabOpenIcon from '@/assets/interface-icons/open-new-tab.svg';
|
||||
import IframeOpenIcon from '@/assets/interface-icons/open-iframe.svg';
|
||||
import WorkspaceOpenIcon from '@/assets/interface-icons/open-workspace.svg';
|
||||
|
||||
export default {
|
||||
name: 'ContextMenu',
|
||||
inject: ['config'],
|
||||
components: {
|
||||
SameTabOpenIcon,
|
||||
NewTabOpenIcon,
|
||||
IframeOpenIcon,
|
||||
WorkspaceOpenIcon,
|
||||
},
|
||||
props: {
|
||||
posX: Number, // The X coordinate for positioning
|
||||
posY: Number, // The Y coordinate for positioning
|
||||
show: Boolean, // Should show or hide the menu
|
||||
},
|
||||
data() {
|
||||
return {
|
||||
menuEnabled: !this.isMenuDisabled(), // Specifies if the context menu should be used
|
||||
};
|
||||
},
|
||||
methods: {
|
||||
/* Called on item click, emits an event up to Item */
|
||||
/* in order to launch the current app to a given target */
|
||||
launch(target) {
|
||||
this.$emit('contextItemClick', target);
|
||||
},
|
||||
/* Checks if the user as disabled context menu in config */
|
||||
isMenuDisabled() {
|
||||
if (this.config && this.config.appConfig) {
|
||||
return !!this.config.appConfig.disableContextMenu;
|
||||
}
|
||||
return false;
|
||||
},
|
||||
},
|
||||
};
|
||||
</script>
|
||||
|
||||
<style lang="scss">
|
||||
|
||||
div.context-menu {
|
||||
position: absolute;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
z-index: 8;
|
||||
background: var(--context-menu-background);
|
||||
color: var(--context-menu-color);
|
||||
border: 1px solid var(--context-menu-secondary-color);
|
||||
border-radius: var(--curve-factor);
|
||||
box-shadow: var(--context-menu-shadow);
|
||||
opacity: 0.98;
|
||||
|
||||
ul {
|
||||
list-style-type: none;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
li {
|
||||
cursor: pointer;
|
||||
padding: 0.5rem 1rem;
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
font-size: 1rem;
|
||||
&:not(:last-child) {
|
||||
border-bottom: 1px solid var(--context-menu-secondary-color);
|
||||
}
|
||||
&:hover {
|
||||
background: var(--context-menu-secondary-color);
|
||||
}
|
||||
svg {
|
||||
width: 1rem;
|
||||
margin-right: 0.5rem;
|
||||
path { fill: currentColor; }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Define enter and leave transitions
|
||||
.slide-enter-active { animation: slide-in .1s; }
|
||||
.slide-leave-active { animation: slide-in .1s reverse; }
|
||||
@keyframes slide-in {
|
||||
0% { transform: scaleY(0.5) scaleX(0.8) translateY(-50px); }
|
||||
100% { transform: scaleY(1) translateY(0) translateY(0); }
|
||||
}
|
||||
</style>
|
||||
@ -1,6 +1,9 @@
|
||||
<template ref="container">
|
||||
<div class="item-wrapper">
|
||||
<a @click="itemOpened"
|
||||
:href="target !== 'iframe' ? url : '#'"
|
||||
@mouseup.right="openContextMenu"
|
||||
@contextmenu.prevent
|
||||
:href="target !== 'modal' ? url : '#'"
|
||||
:target="target === 'newtab' ? '_blank' : ''"
|
||||
:class="`item ${!icon? 'short': ''} size-${itemSize}`"
|
||||
v-tooltip="getTooltipOptions()"
|
||||
@ -19,6 +22,7 @@
|
||||
<!-- Small icon, showing opening method on hover -->
|
||||
<ItemOpenMethodIcon class="opening-method-icon" :isSmall="!icon" :openingMethod="target"
|
||||
:position="itemSize === 'medium'? 'bottom right' : 'top right'"/>
|
||||
<!-- Status indicator dot (if enabled) showing weather srevice is availible -->
|
||||
<StatusIndicator
|
||||
class="status-indicator"
|
||||
v-if="enableStatusCheck"
|
||||
@ -26,13 +30,24 @@
|
||||
:statusText="statusResponse ? statusResponse.message : undefined"
|
||||
/>
|
||||
</a>
|
||||
<ContextMenu
|
||||
:show="contextMenuOpen"
|
||||
v-click-outside="closeContextMenu"
|
||||
:posX="contextPos.posX"
|
||||
:posY="contextPos.posY"
|
||||
:id="`context-menu-${id}`"
|
||||
@contextItemClick="contextItemClick"
|
||||
/>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
import axios from 'axios';
|
||||
import router from '@/router';
|
||||
import Icon from '@/components/LinkItems/ItemIcon.vue';
|
||||
import ItemOpenMethodIcon from '@/components/LinkItems/ItemOpenMethodIcon';
|
||||
import StatusIndicator from '@/components/LinkItems/StatusIndicator';
|
||||
import ContextMenu from '@/components/LinkItems/ContextMenu';
|
||||
|
||||
export default {
|
||||
name: 'Item',
|
||||
@ -45,40 +60,63 @@ export default {
|
||||
color: String, // Optional text and icon color, specified in hex code
|
||||
backgroundColor: String, // Optional item background color
|
||||
url: String, // URL to the resource, optional but recommended
|
||||
target: { // Where resource will open, either 'newtab', 'sametab' or 'iframe'
|
||||
target: { // Where resource will open, either 'newtab', 'sametab' or 'modal'
|
||||
type: String,
|
||||
default: 'newtab',
|
||||
validator: (value) => ['newtab', 'sametab', 'iframe'].indexOf(value) !== -1,
|
||||
validator: (value) => ['newtab', 'sametab', 'modal', 'workspace'].indexOf(value) !== -1,
|
||||
},
|
||||
itemSize: String,
|
||||
enableStatusCheck: Boolean,
|
||||
statusCheckHeaders: Object,
|
||||
statusCheckUrl: String,
|
||||
statusCheckInterval: Number,
|
||||
},
|
||||
data() {
|
||||
return {
|
||||
contextMenuOpen: false,
|
||||
getId: this.id,
|
||||
customStyles: {
|
||||
color: this.color,
|
||||
background: this.backgroundColor,
|
||||
},
|
||||
statusResponse: undefined,
|
||||
contextPos: {
|
||||
posX: undefined,
|
||||
posY: undefined,
|
||||
},
|
||||
};
|
||||
},
|
||||
components: {
|
||||
Icon,
|
||||
ItemOpenMethodIcon,
|
||||
StatusIndicator,
|
||||
ContextMenu,
|
||||
},
|
||||
methods: {
|
||||
/* Called when an item is clicked, manages the opening of iframe & resets the search field */
|
||||
/* Called when an item is clicked, manages the opening of modal & resets the search field */
|
||||
itemOpened(e) {
|
||||
if (e.altKey || this.target === 'iframe') {
|
||||
if (e.altKey || this.target === 'modal') {
|
||||
e.preventDefault();
|
||||
this.$emit('triggerModal', this.url);
|
||||
} else {
|
||||
this.$emit('itemClicked');
|
||||
}
|
||||
},
|
||||
/* Open custom context menu, and set position */
|
||||
openContextMenu(e) {
|
||||
this.contextMenuOpen = !this.contextMenuOpen;
|
||||
if (e && window) {
|
||||
// Calculate placement based on cursor and scroll position
|
||||
this.contextPos = {
|
||||
posX: e.clientX + window.pageXOffset,
|
||||
posY: e.clientY + window.pageYOffset,
|
||||
};
|
||||
}
|
||||
},
|
||||
/* Closes the context menu, called when user clicks literally anywhere */
|
||||
closeContextMenu() {
|
||||
this.contextMenuOpen = false;
|
||||
},
|
||||
/* Returns configuration object for the tooltip */
|
||||
getTooltipOptions() {
|
||||
return {
|
||||
@ -97,15 +135,18 @@ export default {
|
||||
switch (this.target) {
|
||||
case 'newtab': return '"\\f360"';
|
||||
case 'sametab': return '"\\f24d"';
|
||||
case 'iframe': return '"\\f2d0"';
|
||||
case 'modal': return '"\\f2d0"';
|
||||
default: return '"\\f054"';
|
||||
}
|
||||
},
|
||||
/* Checks if a given service is currently online */
|
||||
checkWebsiteStatus() {
|
||||
this.statusResponse = undefined;
|
||||
const baseUrl = process.env.VUE_APP_DOMAIN || window.location.origin;
|
||||
const endpoint = `${baseUrl}/ping?url=${this.url}`;
|
||||
axios.get(endpoint)
|
||||
const urlToCheck = this.statusCheckUrl || this.url;
|
||||
const headers = this.statusCheckHeaders || {};
|
||||
const endpoint = `${baseUrl}/ping?url=${urlToCheck}`;
|
||||
axios.get(endpoint, { headers })
|
||||
.then((response) => {
|
||||
if (response.data) this.statusResponse = response.data;
|
||||
})
|
||||
@ -116,9 +157,31 @@ export default {
|
||||
};
|
||||
});
|
||||
},
|
||||
/* Handle navigation options from the context menu */
|
||||
contextItemClick(method) {
|
||||
const { url } = this;
|
||||
this.contextMenuOpen = false;
|
||||
switch (method) {
|
||||
case 'newtab':
|
||||
window.open(url, '_blank');
|
||||
break;
|
||||
case 'sametab':
|
||||
window.open(url, '_self');
|
||||
break;
|
||||
case 'modal':
|
||||
this.$emit('triggerModal', url);
|
||||
break;
|
||||
case 'workspace':
|
||||
router.push({ name: 'workspace', query: { url } });
|
||||
break;
|
||||
default: window.open(url, '_blank');
|
||||
}
|
||||
},
|
||||
},
|
||||
mounted() {
|
||||
// If ststus checking is enabled, then check service status
|
||||
if (this.enableStatusCheck) this.checkWebsiteStatus();
|
||||
// If continious status checking is enabled, then start ever-lasting loop
|
||||
if (this.statusCheckInterval > 0) {
|
||||
setInterval(this.checkWebsiteStatus, this.statusCheckInterval * 1000);
|
||||
}
|
||||
@ -128,6 +191,10 @@ export default {
|
||||
|
||||
<style lang="scss">
|
||||
|
||||
.item-wrapper {
|
||||
flex-grow: 1;
|
||||
}
|
||||
|
||||
.item {
|
||||
flex-grow: 1;
|
||||
color: var(--item-text-color);
|
||||
@ -147,6 +214,7 @@ export default {
|
||||
&:hover {
|
||||
box-shadow: var(--item-hover-shadow);
|
||||
background: var(--item-background-hover);
|
||||
color: var(--item-text-color-hover);
|
||||
position: relative;
|
||||
.tile-title span.text {
|
||||
white-space: pre-wrap;
|
||||
@ -211,24 +279,29 @@ export default {
|
||||
|
||||
/* Specify layout for alternate sized icons */
|
||||
.item {
|
||||
/* Small Tile Specific Themes */
|
||||
&.size-small {
|
||||
display: flex;
|
||||
flex-direction: row-reverse;
|
||||
justify-content: flex-end;
|
||||
align-items: center;
|
||||
height: 2rem;
|
||||
padding-top: 4px;
|
||||
div img, div svg.missing-image {
|
||||
width: 2rem;
|
||||
}
|
||||
.tile-title {
|
||||
height: fit-content;
|
||||
min-height: 1.2rem;
|
||||
text-align: left;
|
||||
max-width:140px;
|
||||
span.text {
|
||||
text-align: left;
|
||||
padding-left: 10%;
|
||||
}
|
||||
}
|
||||
}
|
||||
/* Medium Tile Specific Themes */
|
||||
&.size-medium {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
@ -243,14 +316,42 @@ export default {
|
||||
max-width: 160px;
|
||||
}
|
||||
}
|
||||
/* Large Tile Specific Themes */
|
||||
&.size-large {
|
||||
height: 100px;
|
||||
display: flex;
|
||||
flex-direction: row-reverse;
|
||||
justify-content: flex-end;
|
||||
text-align: left;
|
||||
overflow: hidden;
|
||||
align-items: center;
|
||||
max-height: 6rem;
|
||||
margin: 0.2rem;
|
||||
padding: 0.5rem;
|
||||
img {
|
||||
padding: 0.1rem 0.25rem;
|
||||
}
|
||||
.tile-title {
|
||||
height: auto;
|
||||
padding: 0.1rem 0.25rem;
|
||||
span.text {
|
||||
position: relative;
|
||||
font-weight: bold;
|
||||
font-size: 1.1rem;
|
||||
width: 100%;
|
||||
}
|
||||
p.description {
|
||||
display: block;
|
||||
margin: 0;
|
||||
white-space: pre-wrap;
|
||||
font-size: .9em;
|
||||
text-overflow: ellipsis;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
p.description {
|
||||
display: none;
|
||||
display: none; // By default, we don't show the description
|
||||
}
|
||||
&:before {
|
||||
&:before { // Certain themes (e.g. material) show css animated fas icon on hover
|
||||
display: none;
|
||||
font-family: FontAwesome;
|
||||
content: var(--open-icon, "\f054") !important;
|
||||
|
||||
@ -27,6 +27,8 @@
|
||||
:target="item.target"
|
||||
:color="item.color"
|
||||
:backgroundColor="item.backgroundColor"
|
||||
:statusCheckUrl="item.statusCheckUrl"
|
||||
:statusCheckHeaders="item.statusCheckHeaders"
|
||||
:itemSize="newItemSize"
|
||||
:enableStatusCheck="shouldEnableStatusCheck(item.statusCheck)"
|
||||
:statusCheckInterval="getStatusCheckInterval()"
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
<template>
|
||||
<div class="item-icon">
|
||||
<i v-if="iconType === 'font-awesome'" :class="`${icon} ${size}`" ></i>
|
||||
<i v-else-if="iconType === 'emoji'" :class="`emoji-icon ${size}`" >{{getEmoji(iconPath)}}</i>
|
||||
<img v-else-if="icon" :src="iconPath" @error="imageNotFound"
|
||||
:class="`tile-icon ${size} ${broken ? 'broken' : ''}`"
|
||||
/>
|
||||
@ -12,6 +13,8 @@
|
||||
import BrokenImage from '@/assets/interface-icons/broken-icon.svg';
|
||||
import ErrorHandler from '@/utils/ErrorHandler';
|
||||
import { faviconApi as defaultFaviconApi, faviconApiEndpoints } from '@/utils/defaults';
|
||||
import EmojiUnicodeRegex from '@/utils/EmojiUnicodeRegex';
|
||||
import emojiLookup from '@/utils/emojis.json';
|
||||
|
||||
export default {
|
||||
name: 'Icon',
|
||||
@ -52,6 +55,27 @@ export default {
|
||||
if (splitPath.length >= 1) return validImgExtensions.includes(splitPath[1]);
|
||||
return false;
|
||||
},
|
||||
/* Determins if a given string is an emoji, and if so what type it is */
|
||||
isEmoji(img) {
|
||||
if (EmojiUnicodeRegex.test(img) && img.match(/./gu).length) { // Is a unicode emoji
|
||||
return { isEmoji: true, emojiType: 'glyph' };
|
||||
} else if (new RegExp(/^:.*:$/).test(img)) { // Is a shortcode emoji
|
||||
return { isEmoji: true, emojiType: 'shortcode' };
|
||||
} else if (img.substring(0, 2) === 'U+' && img.length === 7) {
|
||||
return { isEmoji: true, emojiType: 'unicode' };
|
||||
}
|
||||
return { isEmoji: false, emojiType: '' };
|
||||
},
|
||||
/* Formats and gets emoji from unicode or shortcode */
|
||||
getEmoji(emojiCode) {
|
||||
const { emojiType } = this.isEmoji(emojiCode);
|
||||
if (emojiType === 'shortcode') {
|
||||
if (emojiLookup[emojiCode]) return emojiLookup[emojiCode];
|
||||
} else if (emojiType === 'unicode') {
|
||||
return String.fromCodePoint(parseInt(emojiCode.substr(2), 16));
|
||||
}
|
||||
return emojiCode; // Emoji is a glyph already, just return
|
||||
},
|
||||
/* Get favicon URL, for items which use the favicon as their icon */
|
||||
getFavicon(fullUrl) {
|
||||
if (this.shouldUseDefaultFavicon(fullUrl)) { // Check if we should use local icon
|
||||
@ -85,6 +109,7 @@ export default {
|
||||
case 'favicon': return this.getFavicon(url);
|
||||
case 'generative': return this.getGenerativeIcon(url);
|
||||
case 'svg': return img;
|
||||
case 'emoji': return img;
|
||||
default: return '';
|
||||
}
|
||||
},
|
||||
@ -98,6 +123,7 @@ export default {
|
||||
else if (img.includes('fa-')) imgType = 'font-awesome';
|
||||
else if (img === 'favicon') imgType = 'favicon';
|
||||
else if (img === 'generative') imgType = 'generative';
|
||||
else if (this.isEmoji(img).isEmoji) imgType = 'emoji';
|
||||
else imgType = 'none';
|
||||
return imgType;
|
||||
},
|
||||
@ -144,7 +170,17 @@ export default {
|
||||
fill: currentColor;
|
||||
}
|
||||
}
|
||||
|
||||
i.emoji-icon {
|
||||
font-style: normal;
|
||||
font-size: 2rem;
|
||||
margin: 0.2rem;
|
||||
&.small {
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
&.large {
|
||||
font-size: 2.5rem;
|
||||
}
|
||||
}
|
||||
.missing-image {
|
||||
width: 3.5rem;
|
||||
path {
|
||||
|
||||
@ -2,19 +2,24 @@
|
||||
<div :class="makeClass(position, isSmall, isTransparent)">
|
||||
<NewTabOpenIcon v-if="openingMethod === 'newtab'" />
|
||||
<SameTabOpenIcon v-else-if="openingMethod === 'sametab'" />
|
||||
<IframeOpenIcon v-else-if="openingMethod === 'iframe'" />
|
||||
<IframeOpenIcon v-else-if="openingMethod === 'modal'" />
|
||||
<WorkspaceOpenIcon v-else-if="openingMethod === 'workspace'" />
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script>
|
||||
/* This component displays a small icon, indicating opening method */
|
||||
|
||||
// Import Icons
|
||||
import NewTabOpenIcon from '@/assets/interface-icons/open-new-tab.svg';
|
||||
import SameTabOpenIcon from '@/assets/interface-icons/open-current-tab.svg';
|
||||
import IframeOpenIcon from '@/assets/interface-icons/open-iframe.svg';
|
||||
import WorkspaceOpenIcon from '@/assets/interface-icons/open-workspace.svg';
|
||||
|
||||
export default {
|
||||
name: 'ItemOpenMethodIcon',
|
||||
props: {
|
||||
openingMethod: String, // newtab | sametab | iframe
|
||||
openingMethod: String, // newtab | sametab | modal | workspace
|
||||
isSmall: Boolean, // If true, will apply small class
|
||||
position: String, // Position classes: top, bottom, left, right
|
||||
isTransparent: Boolean, // If true, will apply opacity
|
||||
@ -32,6 +37,7 @@ export default {
|
||||
NewTabOpenIcon,
|
||||
SameTabOpenIcon,
|
||||
IframeOpenIcon,
|
||||
WorkspaceOpenIcon,
|
||||
},
|
||||
};
|
||||
</script>
|
||||
|
||||
@ -36,7 +36,7 @@ footer {
|
||||
text-align: center;
|
||||
color: var(--medium-grey);
|
||||
opacity: var(--dimming-factor);
|
||||
background: var(--background-darker);
|
||||
background: var(--footer-background);
|
||||
margin-top: 1.5rem;
|
||||
border-top: 1px solid var(--outline-color);
|
||||
@include tablet-down {
|
||||
|
||||
@ -83,7 +83,7 @@ export default {
|
||||
background: var(--search-container-background);
|
||||
label {
|
||||
display: inline;
|
||||
color: var(--settings-text-color);
|
||||
color: var(--search-label-color);
|
||||
margin: 0.5rem;
|
||||
display: inline;
|
||||
}
|
||||
|
||||
10
src/main.js
10
src/main.js
@ -7,16 +7,18 @@ import VSelect from 'vue-select'; // Select dropdown component
|
||||
import VTabs from 'vue-material-tabs'; // Tab view component, used on the config page
|
||||
import Toasted from 'vue-toasted'; // Toast component, used to show confirmation notifications
|
||||
|
||||
import { toastedOptions } from './utils/defaults';
|
||||
import Dashy from './App.vue';
|
||||
import router from './router';
|
||||
import registerServiceWorker from './registerServiceWorker';
|
||||
import { toastedOptions } from '@/utils/defaults';
|
||||
import Dashy from '@/App.vue';
|
||||
import router from '@/router';
|
||||
import registerServiceWorker from '@/registerServiceWorker';
|
||||
import clickOutside from '@/utils/ClickOutside';
|
||||
|
||||
Vue.use(VTooltip);
|
||||
Vue.use(VModal);
|
||||
Vue.use(VTabs);
|
||||
Vue.use(Toasted, toastedOptions);
|
||||
Vue.component('v-select', VSelect);
|
||||
Vue.directive('clickOutside', clickOutside);
|
||||
|
||||
Vue.config.productionTip = false;
|
||||
|
||||
|
||||
@ -42,6 +42,7 @@
|
||||
--nav-link-border-color: transparent;
|
||||
--nav-link-border-color-hover: var(--primary);
|
||||
--item-text-color: var(--primary);
|
||||
--item-text-color-hover: var(--item-text-color);
|
||||
--item-group-outer-background: var(--primary);
|
||||
--item-group-heading-text-color: var(--item-group-background);
|
||||
--item-group-heading-text-color-hover: var(--background);
|
||||
@ -49,8 +50,10 @@
|
||||
--settings-text-color: var(--primary);
|
||||
--search-container-background: var(--background-darker);
|
||||
--search-field-background: var(--background);
|
||||
--search-label-color: var(--settings-text-color);
|
||||
--footer-text-color: var(--medium-grey);
|
||||
--footer-text-color-link: var(--primary);
|
||||
--footer-background: var(--background-darker);
|
||||
--welcome-popup-background: var(--background-darker);
|
||||
--welcome-popup-text-color: var(--primary);
|
||||
--config-code-background: #fff;
|
||||
@ -78,4 +81,8 @@
|
||||
--status-check-tooltip-color: var(--primary);
|
||||
--code-editor-color: var(--black);
|
||||
--code-editor-background: var(--white);
|
||||
|
||||
--context-menu-background: var(--background);
|
||||
--context-menu-color: var(--primary);
|
||||
--context-menu-secondary-color: var(--background-darker);
|
||||
}
|
||||
|
||||
@ -88,9 +88,46 @@ html[data-theme='matrix'] {
|
||||
--font-body: 'Cutive Mono', monospace;
|
||||
--font-headings: 'VT323', monospace;
|
||||
--about-page-background: var(--background);
|
||||
--context-menu-secondary-color: var(--primary);
|
||||
.prism-editor-wrapper.my-editor {
|
||||
border: 1px solid var(--primary);
|
||||
}
|
||||
div.context-menu ul li:hover {
|
||||
color: var(--background);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='blue-purple'] {
|
||||
--primary: #54dbf8;
|
||||
--background: #e5e8f5;
|
||||
--background-darker: #5346f3;
|
||||
--font-headings: 'Sniglet', cursive;
|
||||
|
||||
--dimming-factor: 0.8;
|
||||
--curve-factor: 6px;
|
||||
|
||||
--settings-text-color: var(--background-darker);
|
||||
--item-text-color: var(--background-darker);
|
||||
--item-background: var(--white);
|
||||
--item-background-hover: var(--primary);
|
||||
|
||||
--item-group-heading-text-color: var(--background-darker);
|
||||
--item-group-background: var(--background);
|
||||
--footer-text-color: var(--white);
|
||||
--context-menu-background: var(--white);
|
||||
--context-menu-color: var(--background-darker);
|
||||
--context-menu-secondary-color: var(--primary);
|
||||
|
||||
.item {
|
||||
box-shadow: none;
|
||||
border: 1px solid var(--background-darker);
|
||||
}
|
||||
section.filter-container form label {
|
||||
color: var(--primary);
|
||||
}
|
||||
footer {
|
||||
color: var(--white);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='hacker-girl'] {
|
||||
@ -184,6 +221,12 @@ html[data-theme='material-original'] {
|
||||
--about-page-accent: #000;
|
||||
--about-page-color: var(--background-darker);
|
||||
--about-page-background: var(--background);
|
||||
--context-menu-background: var(--white);
|
||||
--context-menu-secondary-color: var(--white);
|
||||
div.context-menu ul li:hover {
|
||||
background: var(--primary);
|
||||
color: var(--white);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='material-dark-original'] {
|
||||
@ -222,6 +265,13 @@ html[data-theme='material-dark-original'] {
|
||||
&::-webkit-scrollbar-thumb {
|
||||
border-left: 1px solid #131a1f;
|
||||
}
|
||||
div.context-menu {
|
||||
border: none;
|
||||
background: #131a1f;
|
||||
ul li:hover {
|
||||
background: #333c43;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='colorful'] {
|
||||
@ -234,14 +284,14 @@ html[data-theme='colorful'] {
|
||||
--item-group-outer-background: #05070e;
|
||||
--item-group-heading-text-color: #e8eae1;
|
||||
--item-group-heading-text-color-hover: #fff;
|
||||
.item:nth-child(1n) { color: #eb5cad; border: 1px solid #eb5cad; }
|
||||
.item:nth-child(2n) { color: #985ceb; border: 1px solid #985ceb; }
|
||||
.item:nth-child(3n) { color: #5c90eb; border: 1px solid #5c90eb; }
|
||||
.item:nth-child(4n) { color: #5cdfeb; border: 1px solid #5cdfeb; }
|
||||
.item:nth-child(5n) { color: #5ceb8d; border: 1px solid #5ceb8d; }
|
||||
.item:nth-child(6n) { color: #afeb5c; border: 1px solid #afeb5c; }
|
||||
.item:nth-child(7n) { color: #ebb75c; border: 1px solid #ebb75c; }
|
||||
.item:nth-child(8n) { color: #eb615c; border: 1px solid #eb615c; }
|
||||
.item-wrapper:nth-child(1n) { .item { color: #eb5cad; border: 1px solid #eb5cad; } }
|
||||
.item-wrapper:nth-child(2n) { .item { color: #985ceb; border: 1px solid #985ceb; } }
|
||||
.item-wrapper:nth-child(3n) { .item { color: #5c90eb; border: 1px solid #5c90eb; } }
|
||||
.item-wrapper:nth-child(4n) { .item { color: #5cdfeb; border: 1px solid #5cdfeb; } }
|
||||
.item-wrapper:nth-child(5n) { .item { color: #5ceb8d; border: 1px solid #5ceb8d; } }
|
||||
.item-wrapper:nth-child(6n) { .item { color: #afeb5c; border: 1px solid #afeb5c; } }
|
||||
.item-wrapper:nth-child(7n) { .item { color: #ebb75c; border: 1px solid #ebb75c; } }
|
||||
.item-wrapper:nth-child(8n) { .item { color: #eb615c; border: 1px solid #eb615c; } }
|
||||
.item:hover, .item:focus {
|
||||
opacity: 0.85;
|
||||
outline: none;
|
||||
@ -253,12 +303,20 @@ html[data-theme='colorful'] {
|
||||
h1, h2, h3, h4 {
|
||||
font-weight: normal;
|
||||
}
|
||||
div.context-menu {
|
||||
border-color: var(--primary);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='minimal-light'], html[data-theme='minimal-dark'], html[data-theme='vaporware'] {
|
||||
--font-body: 'Courier New', monospace;
|
||||
--font-headings: 'Courier New', monospace;
|
||||
--footer-height: 94px;
|
||||
|
||||
.item.size-medium .tile-title {
|
||||
max-width: 100px;
|
||||
}
|
||||
|
||||
label.lbl-toggle h3 {
|
||||
font-size: 1.8rem;
|
||||
}
|
||||
@ -449,6 +507,7 @@ html[data-theme='material'] {
|
||||
--welcome-popup-text-color: #f5f5f5;
|
||||
--footer-text-color: #f5f5f5cc;
|
||||
// --login-form-background-secondary: #f5f5f5cc;
|
||||
--context-menu-secondary-color: #f5f5f5;
|
||||
|
||||
header {
|
||||
background: #4285f4;
|
||||
@ -467,6 +526,14 @@ html[data-theme='material'] {
|
||||
.prism-editor-wrapper {
|
||||
background: #f5f5f5;
|
||||
}
|
||||
.item:focus {
|
||||
outline-color: #4285f4cc;
|
||||
}
|
||||
div.context-menu {
|
||||
border: none;
|
||||
background: var(--white);
|
||||
ul li:hover { svg path { fill: var(--background-darker); }}
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='material-dark'] {
|
||||
@ -521,6 +588,13 @@ html[data-theme='material-dark'] {
|
||||
background: #131a1f !important;
|
||||
}
|
||||
}
|
||||
div.context-menu {
|
||||
border: none;
|
||||
background: var(--background);
|
||||
ul li:hover {
|
||||
background: #131a1f;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='minimal-light'] {
|
||||
@ -547,7 +621,8 @@ html[data-theme='minimal-light'] {
|
||||
--login-form-color: #101931;
|
||||
--about-page-background: var(--background);
|
||||
--about-page-color: var(--background-darker);
|
||||
|
||||
--context-menu-color: var(--background-darker);
|
||||
--context-menu-secondary-color: var(--primary);
|
||||
section.filter-container {
|
||||
background: #fff;
|
||||
border-bottom: 1px dashed #00000038;
|
||||
@ -592,6 +667,10 @@ html[data-theme='minimal-dark'] {
|
||||
border: 1px solid #fff;
|
||||
}
|
||||
}
|
||||
|
||||
div.context-menu {
|
||||
border-color: var(--primary);
|
||||
}
|
||||
}
|
||||
|
||||
html[data-theme='vaporware'] {
|
||||
@ -613,7 +692,8 @@ html[data-theme='vaporware'] {
|
||||
--curve-factor: 2px;
|
||||
--curve-factor-navbar: 6px;
|
||||
--login-form-color: #09bfe6;
|
||||
|
||||
--config-settings-background: #100e2c;
|
||||
|
||||
.home {
|
||||
background: linear-gradient(180deg, rgba(16,14,44,1) 10%, rgba(27,24,79,1) 40%, rgba(16,14,44,1) 100%);
|
||||
}
|
||||
@ -674,4 +754,30 @@ html[data-theme='vaporware'] {
|
||||
// background-size: cover;
|
||||
// div.home { background: none; }
|
||||
// }
|
||||
}
|
||||
|
||||
html[data-theme='cyberpunk'] {
|
||||
--pink: #ff2a6d;
|
||||
--pale: #d1f7ff;
|
||||
--aqua: #05d9e8;
|
||||
--teal: #005678;
|
||||
--blue: #01012b;
|
||||
--gold: #ebeb0f;
|
||||
|
||||
--primary: var(--gold);
|
||||
--background: var(--blue);
|
||||
--background-darker: var(--pink);
|
||||
--heading-text-color: var(--blue);
|
||||
--nav-link-background-color-hover: var(--blue);
|
||||
--nav-link-text-color-hover: var(--pink);
|
||||
--nav-link-border-color-hover: var(--blue);
|
||||
--config-settings-background: var(--blue);
|
||||
--config-settings-color: var(--pink);
|
||||
--search-label-color: var(--blue);
|
||||
--item-group-background: var(--blue);
|
||||
--item-text-color: var(--pale);
|
||||
--scroll-bar-color: var(--aqua);
|
||||
--scroll-bar-background: var(--teal);
|
||||
--footer-background: var(--aqua);
|
||||
--font-headings: 'Audiowide', cursive;
|
||||
}
|
||||
@ -19,6 +19,7 @@
|
||||
--item-icon-transform: drop-shadow(2px 4px 6px var(--transparent-50)) saturate(0.65);
|
||||
--item-icon-transform-hover: drop-shadow(4px 8px 3px var(--transparent-50)) saturate(2);
|
||||
--item-group-shadow: var(--item-shadow);
|
||||
--context-menu-shadow: var(--item-shadow);
|
||||
|
||||
/* Settings and config menu */
|
||||
--settings-container-shadow: none;
|
||||
|
||||
@ -42,7 +42,6 @@ html {
|
||||
font-weight: normal;
|
||||
}
|
||||
}
|
||||
|
||||
/* Optional fonts for specific themes */
|
||||
/* These fonts are loaded from ./public and therefore not bundled within the apps source */
|
||||
@font-face { // Used by Dracula. Credit to Matt McInerney
|
||||
@ -73,3 +72,9 @@ html {
|
||||
font-family: 'VT323';
|
||||
src: url('/fonts/VT323-Regular.ttf');
|
||||
}
|
||||
|
||||
@font-face { // Used by cyberpunk theme. Credit to Astigmatic
|
||||
font-family: 'Audiowide';
|
||||
src: url('/fonts/Audiowide-Regular.ttf');
|
||||
}
|
||||
|
||||
|
||||
@ -1,8 +1,18 @@
|
||||
import sha256 from 'crypto-js/sha256';
|
||||
import { cookieKeys, localStorageKeys } from './defaults';
|
||||
|
||||
/**
|
||||
* Generates a 1-way hash, in order to be stored in local storage for authentication
|
||||
* @param {String} user The username of user
|
||||
* @returns {String} The hashed token
|
||||
*/
|
||||
const generateUserToken = (user) => sha256(user.toString()).toString().toLowerCase();
|
||||
|
||||
/**
|
||||
* Checks if the user is currently authenticated
|
||||
* @param {Array[Object]} users An array of user objects pulled from the config
|
||||
* @returns {Boolean} Will return true if the user is logged in, else false
|
||||
*/
|
||||
export const isLoggedIn = (users) => {
|
||||
const validTokens = users.map((user) => generateUserToken(user));
|
||||
let userAuthenticated = false;
|
||||
@ -20,6 +30,15 @@ export const isLoggedIn = (users) => {
|
||||
return userAuthenticated;
|
||||
};
|
||||
|
||||
/**
|
||||
* Checks credentials entered by the user against those in the config
|
||||
* Returns an object containing a boolean indicating success/ failure
|
||||
* along with a message outlining what's not right
|
||||
* @param {String} username The username entered by the user
|
||||
* @param {String} pass The password entered by the user
|
||||
* @param {String[]} users An array of valid user objects
|
||||
* @returns {Object} An object containing a boolean result and a message
|
||||
*/
|
||||
export const checkCredentials = (username, pass, users) => {
|
||||
let response;
|
||||
if (!username) {
|
||||
@ -40,12 +59,24 @@ export const checkCredentials = (username, pass, users) => {
|
||||
return response || { correct: false, msg: 'User not found' };
|
||||
};
|
||||
|
||||
export const login = (username, pass) => {
|
||||
/**
|
||||
* Sets the cookie value in order to login the user locally
|
||||
* @param {String} username - The users username
|
||||
* @param {String} pass - Password, not yet hashed
|
||||
* @param {Number} timeout - A desired timeout for the session, in ms
|
||||
*/
|
||||
export const login = (username, pass, timeout) => {
|
||||
const now = new Date();
|
||||
const expiry = new Date(now.setTime(now.getTime() + timeout)).toGMTString();
|
||||
const userObject = { user: username, hash: sha256(pass).toString().toLowerCase() };
|
||||
document.cookie = `authenticationToken=${generateUserToken(userObject)}; max-age=600`;
|
||||
document.cookie = `authenticationToken=${generateUserToken(userObject)};`
|
||||
+ `${timeout > 0 ? `expires=${expiry}` : ''}`;
|
||||
localStorage.setItem(localStorageKeys.USERNAME, username);
|
||||
};
|
||||
|
||||
/**
|
||||
* Removed the browsers cookie, causing user to be logged out
|
||||
*/
|
||||
export const logout = () => {
|
||||
document.cookie = 'authenticationToken=null';
|
||||
localStorage.removeItem(localStorageKeys.USERNAME);
|
||||
@ -57,8 +88,8 @@ export const logout = () => {
|
||||
* But if auth is configured, then will verify user is correctly
|
||||
* logged in and then check weather they are of type admin, and
|
||||
* return false if any conditions fail
|
||||
* @param users[] : Array of users
|
||||
* @returns Boolean : True if admin privileges
|
||||
* @param {String[]} - Array of users
|
||||
* @returns {Boolean} - True if admin privileges
|
||||
*/
|
||||
export const isUserAdmin = (users) => {
|
||||
if (!users || users.length === 0) return true; // Authentication not setup
|
||||
|
||||
37
src/utils/ClickOutside.js
Normal file
37
src/utils/ClickOutside.js
Normal file
@ -0,0 +1,37 @@
|
||||
/**
|
||||
* A simple Vue directive to trigger an event when the user
|
||||
* clicks anywhere other than the specified element.
|
||||
* Used to close context menu's popup menus and tips.
|
||||
*/
|
||||
|
||||
const instances = [];
|
||||
|
||||
function onDocumentClick(e, el, fn) {
|
||||
const { target } = e;
|
||||
if (el !== target && !el.contains(target)) {
|
||||
fn(e);
|
||||
}
|
||||
}
|
||||
|
||||
export default {
|
||||
bind(element, binding) {
|
||||
const el = element;
|
||||
el.dataset.outsideClickIndex = instances.length;
|
||||
|
||||
const fn = binding.value;
|
||||
const click = (e) => {
|
||||
onDocumentClick(e, el, fn);
|
||||
};
|
||||
|
||||
document.addEventListener('click', click);
|
||||
document.addEventListener('touchstart', click);
|
||||
instances.push(click);
|
||||
},
|
||||
unbind(el) {
|
||||
if (!el.dataset) return;
|
||||
const index = el.dataset.outsideClickIndex;
|
||||
const handler = instances[index];
|
||||
document.removeEventListener('click', handler);
|
||||
instances.splice(index, 1);
|
||||
},
|
||||
};
|
||||
@ -56,8 +56,31 @@
|
||||
},
|
||||
"theme": {
|
||||
"type": "string",
|
||||
"default": "Callisto",
|
||||
"description": "A theme to be applied by default on first load"
|
||||
"default": "callisto",
|
||||
"description": "A theme to be applied by default on first load",
|
||||
"examples": [
|
||||
"callisto",
|
||||
"thebe",
|
||||
"dracula",
|
||||
"material",
|
||||
"material-dark",
|
||||
"colorful",
|
||||
"nord",
|
||||
"nord-frost",
|
||||
"minimal-dark",
|
||||
"minimal-light",
|
||||
"matrix",
|
||||
"matrix-red",
|
||||
"hacker-girl",
|
||||
"raspberry-jam",
|
||||
"bee",
|
||||
"tiger",
|
||||
"material-original",
|
||||
"material-dark-original",
|
||||
"vaporware",
|
||||
"high-contrast-dark",
|
||||
"high-contrast-light"
|
||||
]
|
||||
},
|
||||
"enableFontAwesome": {
|
||||
"type": "boolean",
|
||||
@ -176,7 +199,12 @@
|
||||
"disableServiceWorker": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "If set to true, then service worker will not be used"
|
||||
"description": "If set to true, then service workers will not be used to cache page contents"
|
||||
},
|
||||
"disableContextMenu": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "If set to true, custom right-click context menu will be disabled"
|
||||
}
|
||||
},
|
||||
"additionalProperties": false
|
||||
@ -295,7 +323,8 @@
|
||||
"enum": [
|
||||
"newtab",
|
||||
"sametab",
|
||||
"iframe"
|
||||
"modal",
|
||||
"workspace"
|
||||
],
|
||||
"default": "newtab",
|
||||
"description": "Opening method, when item is clicked"
|
||||
@ -312,6 +341,14 @@
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Whether or not to display online/ offline status for this service. Will override appConfig.statusCheck"
|
||||
},
|
||||
"statusCheckUrl": {
|
||||
"type": "string",
|
||||
"description": "If you've enabled statusCheck, and want to use a different URL to what is defined under the item, then specify it here"
|
||||
},
|
||||
"statusCheckHeaders": {
|
||||
"type": "object",
|
||||
"description": " If you're endpoint requires any specific headers for the status checking, then define them here"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
1
src/utils/EmojiUnicodeRegex.js
Normal file
1
src/utils/EmojiUnicodeRegex.js
Normal file
@ -0,0 +1 @@
|
||||
module.exports = /(?:[\u2700-\u27bf]|(?:\ud83c[\udde6-\uddff]){2}|[\ud800-\udbff][\udc00-\udfff]|[\u0023-\u0039]\ufe0f?\u20e3|\u3299|\u3297|\u303d|\u3030|\u24c2|\ud83c[\udd70-\udd71]|\ud83c[\udd7e-\udd7f]|\ud83c\udd8e|\ud83c[\udd91-\udd9a]|\ud83c[\udde6-\uddff]|[\ud83c[\ude01-\ude02]|\ud83c\ude1a|\ud83c\ude2f|[\ud83c[\ude32-\ude3a]|[\ud83c[\ude50-\ude51]|\u203c|\u2049|[\u25aa-\u25ab]|\u25b6|\u25c0|[\u25fb-\u25fe]|\u00a9|\u00ae|\u2122|\u2139|\ud83c\udc04|[\u2600-\u26FF]|\u2b05|\u2b06|\u2b07|\u2b1b|\u2b1c|\u2b50|\u2b55|\u231a|\u231b|\u2328|\u23cf|[\u23e9-\u23f3]|[\u23f8-\u23fa]|\ud83c\udccf|\u2934|\u2935|[\u2190-\u21ff])/;
|
||||
@ -31,8 +31,10 @@ module.exports = {
|
||||
'raspberry-jam',
|
||||
'bee',
|
||||
'tiger',
|
||||
'blue-purple',
|
||||
'material-original',
|
||||
'material-dark-original',
|
||||
'cyberpunk',
|
||||
'vaporware',
|
||||
'high-contrast-dark',
|
||||
'high-contrast-light',
|
||||
|
||||
1919
src/utils/emojis.json
Normal file
1919
src/utils/emojis.json
Normal file
File diff suppressed because it is too large
Load Diff
@ -160,13 +160,17 @@ export default {
|
||||
},
|
||||
/* Checks if any of the icons are Font Awesome glyphs */
|
||||
checkIfFontAwesomeNeeded() {
|
||||
let isFound = false;
|
||||
let isNeeded = false;
|
||||
if (!this.sections) return false;
|
||||
this.sections.forEach((section) => {
|
||||
if (section.icon && section.icon.includes('fa-')) isNeeded = true;
|
||||
section.items.forEach((item) => {
|
||||
if (item.icon && item.icon.includes('fa-')) isFound = true;
|
||||
if (item.icon && item.icon.includes('fa-')) isNeeded = true;
|
||||
});
|
||||
});
|
||||
return isFound;
|
||||
const currentTheme = localStorage[localStorageKeys.THEME]; // Some themes require FA
|
||||
if (['material', 'material-dark'].includes(currentTheme)) isNeeded = true;
|
||||
return isNeeded;
|
||||
},
|
||||
/* Injects font-awesome's script tag, only if needed */
|
||||
initiateFontAwesome() {
|
||||
|
||||
@ -4,6 +4,14 @@
|
||||
<h2 class="login-title">Dashy</h2>
|
||||
<Input v-model="username" label="Username" class="login-field username" type="text" />
|
||||
<Input v-model="password" label="Password" class="login-field password" type="password" />
|
||||
<label>Remember me for</label>
|
||||
<v-select
|
||||
v-model="timeout"
|
||||
:options="dropDownMenu"
|
||||
label="label"
|
||||
:selectOnTab="true"
|
||||
class="login-time-dropdown"
|
||||
/>
|
||||
<Button class="login-button" :click="submitLogin">Login</Button>
|
||||
<transition name="bounce">
|
||||
<p :class="`login-error-message ${status}`" v-show="message">{{ message }}</p>
|
||||
@ -30,6 +38,13 @@ export default {
|
||||
password: '',
|
||||
message: '',
|
||||
status: 'waiting', // wating, error, success
|
||||
timeout: { label: 'Never', time: 0 },
|
||||
dropDownMenu: [ // Data for timeout dropdown menu, label + value
|
||||
{ label: 'Never', time: 0 }, // Time is specified in ms
|
||||
{ label: '4 Hours', time: 14400 * 1000 },
|
||||
{ label: '1 Day', time: 86400 * 1000 },
|
||||
{ label: '1 Week', time: 604800 * 1000 },
|
||||
],
|
||||
};
|
||||
},
|
||||
components: {
|
||||
@ -38,11 +53,12 @@ export default {
|
||||
},
|
||||
methods: {
|
||||
submitLogin() {
|
||||
const timeout = this.timeout.time || 0;
|
||||
const response = checkCredentials(this.username, this.password, this.appConfig.auth || []);
|
||||
this.message = response.msg; // Show error or success message to the user
|
||||
this.status = response.correct ? 'success' : 'error';
|
||||
if (response.correct) { // Yay, credentials were correct :)
|
||||
login(this.username, this.password); // Login, to set the cookie
|
||||
login(this.username, this.password, timeout); // Login, to set the cookie
|
||||
setTimeout(() => { // Wait a short while, then redirect back home
|
||||
router.push({ path: '/' });
|
||||
}, 250);
|
||||
@ -130,4 +146,30 @@ export default {
|
||||
100% { transform: scale(1); }
|
||||
}
|
||||
|
||||
.v-select.login-time-dropdown {
|
||||
margin: 0.5rem 0;
|
||||
.vs__dropdown-toggle {
|
||||
border-color: var(--login-form-color);
|
||||
background: var(--login-form-background);
|
||||
span.vs__selected {
|
||||
color: var(--login-form-color);
|
||||
}
|
||||
.vs__actions svg path { fill: var(--login-form-color); }
|
||||
}
|
||||
ul.vs__dropdown-menu {
|
||||
background: var(--login-form-background);
|
||||
border-color: var(--login-form-color);
|
||||
li {
|
||||
color: var(--login-form-color);
|
||||
&:hover {
|
||||
color: var(--login-form-background);
|
||||
background: var(--login-form-color);
|
||||
}
|
||||
&.vs__dropdown-option--highlight {
|
||||
color: var(--login-form-background) !important;
|
||||
background: var(--login-form-color);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
</style>
|
||||
|
||||
@ -9,8 +9,8 @@ module.exports = {
|
||||
chainWebpack: config => {
|
||||
config.module.rules.delete('svg');
|
||||
},
|
||||
|
||||
configureWebpack: {
|
||||
performance: { hints: false },
|
||||
module: {
|
||||
rules: [
|
||||
{ test: /.svg$/, loader: 'vue-svg-loader' },
|
||||
@ -26,12 +26,12 @@ module.exports = {
|
||||
}),
|
||||
],
|
||||
},
|
||||
|
||||
pwa: {
|
||||
name: 'Dashy',
|
||||
manifestPath: './manifest.json',
|
||||
themeColor: '#00af87',
|
||||
msTileColor: '#0b1021',
|
||||
mode: 'production',
|
||||
iconPaths: {
|
||||
manifestCrossorigin: 'use-credentials',
|
||||
favicon64: './web-icons/favicon-64x64.png',
|
||||
|
||||
Loading…
Reference in New Issue
Block a user