simbaja/homedash repository overview

⁠Home Dashboard

⁠Description

A simple admin-page focused Home Dashboard to keep services organized using a configuration file. Inspired by Homer⁠.

⁠Demo

A fully functional demo is available at: (http://website⁠)

⁠Table of Contents

• Features⁠
• Usage⁠
• Documentation⁠
• Contributing⁠
• License⁠

⁠Features

• yaml⁠ file configuration
• Keycloak authentication
• Responsive
• Embedded service links

⁠Usage

Homedash is a full static html/js dashboard, generated from the source in /src using webpack. It's meant to be served by an HTTP server, it will not work if you open dist/index.html directly over file:// protocol.

⁠Using docker

docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets simbaja/homedash:latest

As a bind mount is used here, docker will not copy the initial content of the assets directory to the mounted directory. You can initialize your assets directory with the content provided in this repository

cp -r /public/assets/* /your/local/assets/

Alternatively if you just want to provide images/icons without customizing the other files, you can mount a custom directory in the www directory and use it in your config.yml for icons path.

⁠Manually

Homedash is a static page that needs to be generated from the source in this repository. Use the following command to build the project:

npm install
npm run build

Then your dashboard is ready to use in the /dist directory.

⁠Development

npm install
npm run serve

⁠Documentation

For information about the config.yml file see the configuration⁠ documentation.

Keycloak support is present, but only helps support SSO scenarios. Since this application is essentially served client-side and doesn't access service-side resources (other than static files), it isn't really protecting anything. However, if you have your SSO tied to the Keycloak login, it forces a login, and then allows you to:

• Maintain the session through background refreshing as long as the dashboard is open
• Opening other services will not cause a login window to appear (unless not tied to SSO)
• Allows access to your profile information from the dashboard
• Allows signoff of your session (useful if you're using forward auth)

Any service that needs authentication/authorization should not rely on the dashboard to provide this functionality.

⁠Content Security Policy Issues

When using Keycloak, it apparently does some unsafe-evals somewhere, so you'll need to make sure your policy allows that, otherwise nothing will display.

⁠Copyright and license

Code released under the MIT license⁠.)