appstore/apps/dashdot/README.md
2023-11-09 19:15:01 +08:00

80 lines
3.2 KiB
Markdown

<!-- markdownlint-disable -->
<h1>
<img src="https://github.com/MauriceNino/dashdot/raw/main/.github/images/banner_muted.png" alt="dash. - a modern server dashboard">
</h1>
<p align="center">
<a href="https://github.com/MauriceNino/dashdot/actions/workflows/deploy.yaml?branch=main" target="_blank">
<img title="GitHub Actions" src="https://github.com/MauriceNino/dashdot/actions/workflows/deploy.yaml/badge.svg?branch=main">
</a>
<a href="https://discord.gg/3teHFBNQ9W" target="_blank">
<img title="Discord" src="https://discord.com/api/guilds/986251291577688064/widget.png?style=shield">
</a>
</p>
<p align="center">
<i>Feel free to join the <b>Discord</b> and <b>star the repo</b> if you like the project!</i>
</p>
<br/>
<p align="center">
<b>dash.</b> (or <b>dashdot</b>) is a modern server dashboard,
running on the latest tech, designed with glassmorphism in mind.
It is intended to be used for smaller VPS and private servers.
</p>
<br />
<p align="center">
<a href="https://dash.mauz.dev" target="_blank">Live Demo</a>
|
<a href="https://hub.docker.com/r/mauricenino/dashdot" target="_blank">Docker Image</a>
</p>
#
<a href="https://ko-fi.com/mauricenino" target="_blank">
<img
align="right"
width="160"
style="padding-left: 20px; padding-bottom: 10px"
alt="Consider sponsoring the development of this project"
src="https://cdn.ko-fi.com/cdn/kofi2.png?v=3"
/>
</a>
<!-- markdownlint-enable -->
**dash.** is a open-source project, so any contribution is highly appreciated.
If you are interested in further developing this project, have a look at the
[Contributing.md](https://github.com/MauriceNino/dashdot/blob/main/.github/CONTRIBUTING.md).
In case you want to financially support this project, you can visit my
[GitHub Sponsors](https://github.com/sponsors/MauriceNino), or my [Ko-Fi](https://ko-fi.com/mauricenino).
## Preview
<!-- markdownlint-disable -->
| Dark-Mode | Light-Mode |
| -------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| <img src="https://github.com/MauriceNino/dashdot/raw/main/apps/docs/static/img/screenshot_darkmode.png" alt="Screenshot of the dark-mode" /> | <img src="https://github.com/MauriceNino/dashdot/raw/main/apps/docs/static/img/screenshot_lightmode.png" alt="Screenshot of the light-mode" /> |
## Quick Install (Docker)
Images are hosted on [DockerHub](https://hub.docker.com/r/mauricenino/dashdot),
and are available for both AMD64 and ARM devices.
```bash
docker container run -it \
-p 80:3001 \
-v /:/mnt/host:ro \
--privileged \
mauricenino/dashdot
```
To get more information on why which flag is needed, or if you want to use other
install options instead (`docker-compose`, or from source), have a look at the
[installation options](https://getdashdot.com/docs/install).
To read more about configuration options, you can visit the [configuration options](https://getdashdot.com/docs/config).