Skip to content

Commit 7442894

Browse files
committed
Initial commit
0 parents  commit 7442894

File tree

4 files changed

+776
-0
lines changed

4 files changed

+776
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Ignore all cache files
2+
*cache.json

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Tech1k
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Simple Node Dashboard
2+
3+
A lightweight, self-hosted dashboard that displays information from your Bitcoin, Litecoin, or Monero node.
4+
5+
6+
## Demos
7+
8+
- [Bitcoin Node Dashboard](https://btc.librenode.com/dashboard)
9+
- [Litecoin Node Dashboard](https://ltc.librenode.com/dashboard)
10+
- [Monero Node Dashboard](https://xmr.librenode.com/dashboard)
11+
12+
13+
## Features
14+
15+
- Clean display of essential node and network statistics
16+
- Filesystem-based caching to reduce RPC I/O
17+
- Minimal and easy setup
18+
- Fully responsive for desktop and mobile devices
19+
20+
21+
## Planned Features
22+
23+
- Light/dark mode
24+
- Custom themes
25+
- Tooltip explanations for stats
26+
27+
28+
## Installation
29+
30+
1. Place `index.php` in a PHP-enabled web directory.
31+
2. Ensure the web server has read/write access to the directory for the cache files.
32+
3. Configure your nodes with the correct RPC credentials and IP allowlist.
33+
4. Update the confguration section at the top of `index.php` to match your node's configuration.
34+
5. Navigate to `index.php` in a web browser of your choice.
35+
36+
37+
## Security Notes
38+
39+
- Make sure to protect the dashboard if you’re displaying sensitive node info.
40+
- Use firewall rules or other methods to restrict access, especially for public deployments.
41+
42+
43+
## License
44+
45+
This project is released under the [MIT License](https://opensource.org/licenses/MIT). See the LICENSE file for more details.

0 commit comments

Comments
 (0)