https://github.com/jez500/bender
A link dashboard that can be managed completely via the browser
https://github.com/jez500/bender
Last synced: about 11 hours ago
JSON representation
A link dashboard that can be managed completely via the browser
- Host: GitHub
- URL: https://github.com/jez500/bender
- Owner: jez500
- License: apache-2.0
- Created: 2022-08-20T01:17:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-08T05:38:01.000Z (over 2 years ago)
- Last Synced: 2025-01-01T06:17:45.607Z (about 2 months ago)
- Language: Vue
- Size: 896 KB
- Stars: 113
- Watchers: 1
- Forks: 5
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bender dashboard
A link dashboard that can be managed without any code. Ideal for service listings on your server. **Heavily**
inspired by [Homer dashboard](https://github.com/bastienwirtz/homer) and aims to provide the same functionality
with one major change, **No yaml required**!
All links can be managed via the UI including dragging and dropping your links to re-order or change groups.
New pages and links can be added via the UI, as can global settings such as the app title, icon and theme.
## Under the hood
* Built using NuxtJS & Vue2
* Requires no database, all config is stored in a single config file `static/config.json`
* FontAwesome solid and brand icons available with inbuilt search
* Image lookup supported via anything in `static/images`
* Light & Dark mode
## Running without docker
* Requires NodeJS 14+
* Run `npm run start`
* Visit http://localhost:8080
## Running with docker
You should volume mount the `/app/static` directory as it contains the `config.json` (the file containing all
links and settings which you will want to persist). It also contains an `images` directory which is used with
the image lookup.
```sh
docker run -d \
--name bender \
-p 8080:8080 \
-v :/app/static \
--restart=always \
jez500/bender:latest
```
#### With docker-compose
A [`docker-compose.yml`](docker-compose.yml) file is available as an example. It must be edited to match
your needs. You probably want to adjust the port mapping and volume binding (equivalent to `-p` and `-v` arguments).
Then launch the container:
```sh
cd /path/to/docker-compose.yml/
docker-compose up -d
```
## Migrating from Homer
Experimental: Backup `static/config.json` first.
You can import your links from homer by visiting `/import`, pasting the Homer YAML then
clicking `Parse`. If the YAML is valid, it should indicate links and groups found. Next, select the page you
want to import into and finally click `Import links` to overwrite all the links on the selected page with
what was in the YAML.
Note: If using images, copy them all into `static/images`.
## Developing
To develop locally, you can just run `npm run dev` and it will serve the app on `http://localhost:8080`
with live reloading of edits.
All PRs are welcome!
## Author
[Jeremy Graham](https://jez.me)
## Attribution
Amazing contributors to [Homer](https://github.com/bastienwirtz/homer/graphs/contributors)