magma/README.md
2023-11-30 09:11:08 +07:00

41 lines
1.4 KiB
Markdown

# Magma dashboard 🌋
Personal dashboard that is highly customizable, lightweight and responsive.
![Magma dashboard preview](./docs/screenshots/flame.png)
## Features
- Lightweight (8-16Mb), fast, build from Go
- Support multiple [languages](https://magma.help14.com/#/customization/languages)
- Support multiple [themes](https://magma.help14.com/#/customization/themes)
- Addons support (WIP)
## How to use
- Download our [docker-compose.yml](./docker-compose.yml) file
- Start with `docker-compose up -d`
- Go to `data/config.yaml` to config your dashboard
- Go to `data/data.yaml` to edit your bookmarks
- See your dashboard at [localhost:7001](http://localhost:7001)
[![Magma on Docker Hub](https://dockeri.co/image/help14/magma)](https://hub.docker.com/r/help14/magma)
## Customization
Go to our [website](https://magma.help14.com) and read the document to learn more.
## Contribution
Contributions welcome and needed!
## Thanks to
- pawelmalak for [flame](https://github.com/pawelmalak/flame)
- migueravila for [simplefox](https://github.com/migueravila/SimpleFox)
- u/Goldtom for [flame css theme](https://www.reddit.com/r/selfhosted/comments/rbb4kk/flame_dashboard_custom_css_tweaks/)
- ramatov-zulfikor for [simplenord](https://github.com/ramatov-zulfikor/startpage)
## Cloudflare Pages
If you don't want to selfhost and have maximum speed, checkout this version: [CF-Magma](https://github.com/help-14/cf-magma)