Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nekoluka/sakuradash
A simple dashboard that you configure with a simple yaml file, and pulls icons from the selfhst/icons project.
https://github.com/nekoluka/sakuradash
Last synced: 21 days ago
JSON representation
A simple dashboard that you configure with a simple yaml file, and pulls icons from the selfhst/icons project.
- Host: GitHub
- URL: https://github.com/nekoluka/sakuradash
- Owner: NekoLuka
- License: gpl-3.0
- Created: 2024-12-17T10:24:13.000Z (24 days ago)
- Default Branch: main
- Last Pushed: 2024-12-18T20:19:01.000Z (22 days ago)
- Last Synced: 2024-12-18T21:24:23.828Z (22 days ago)
- Language: CSS
- Size: 661 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SakuraDash
A simple dashboard that you configure with a simple yaml file, and pulls icons from the selfhst/icons project.## Disclaimer
The current background of the site is generated using AI.
This is to be replaced with commissioned art sometime in the future.## TODO
- Make the config file location configurable
- Implement icon caching
- Implement logging
- Publish a docker image
- Create overrideable static files for customisation## Config
Adapt the following example to your own needs
```yaml
title: SakuraDash
categories:
- name: "Infrastructure"
items:
- name: "OPNSense"
icon: "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/opnsense.webp"
url: "http://opnsense.lan"
- name: "Proxmox"
icon: "https://cdn.jsdelivr.net/gh/selfhst/icons/webp/proxmox.webp"
url: "http://proxmox.lan:8006"
```
### Authelia specif feature
If you put the dashboard behind authelia with groups configured,
you can forward the header `Remote-Groups` from authelia to sakuradash.
This unlocks functionality to show certain categories only to users who belong to the configured group.
Unlock this functionality by adding `view_group` to a categories entry like so:
```yaml
...
categories:
- name: ...
view_group: "jellyfin_users"
items:
...
```
This makes this particular category only visible to users in the `jellyfin_users` group.## Build
Clone the git repo and run the following command:
`docker build -t nekoluka/sakuradash .`## Pull
`docker pull nekoluka/sakuradash`## Running
Run the following command after you build the image:
`docker run -p 8080:8080 -v ./config.yaml:/config.yaml nekoluka/sakuradash`## Screenshot
## Mentions
This project makes use of w3.css