18362765b9
Bumps [github.com/a-h/templ](https://github.com/a-h/templ) from 0.2.778 to 0.2.793. - [Release notes](https://github.com/a-h/templ/releases) - [Changelog](https://github.com/a-h/templ/blob/main/.goreleaser.yaml) - [Commits](https://github.com/a-h/templ/compare/v0.2.778...v0.2.793) --- updated-dependencies: - dependency-name: github.com/a-h/templ dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> |
||
|---|---|---|
| .github | ||
| cmd | ||
| deployment | ||
| internal | ||
| utils | ||
| .air.toml | ||
| .editorconfig | ||
| .env.example | ||
| .gitattributes | ||
| .gitignore | ||
| .golangci.yaml | ||
| bun.lockb | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| main.go | ||
| Makefile | ||
| package.json | ||
| README.md | ||
| server.go | ||
| tailwind.config.js | ||
| VERSION | ||
XMR Remote Nodes
Source code of https://xmr.ditatompel.com, a website that helps you monitor your favourite Monero remote nodes.
⚠️ 🚧 This project is not mature enough 🚧, If you want to use it on your server, please use it with caution.
How does it work?
Apart from CPU architecture type, you can build two types of binaries from this project: a server and a client.
The clients is used to fetch node information given by the server. First, it will ask the server which node to fetch. Then, it will fetch the information and report back to the server.
The server serves an embedded Svelte static site for the Web UI. It also
serves the /api endpoint that is used by the clients and the Web UI itself.
Requirements
To build the executable binaries, you need:
- Go >= 1.22
- Bun >= 1.1.26
- templ v0.2.778
Note
:
- If you want to contribute to the code, please use exact templ version (v0.2.778).
- The UI is using Preline UI that uses [Lucide Icons][lucide-icons], use that for SVG icons.
Server & Prober requirements
- Linux Machines (AMD64 or ARM64)
Server requirements
- MySQL/MariaDB
- GeoIP Database (optional). Place it to
./assets/geoip, see ./internal/ip/geo/geoip.go.
Installation
For initial server setup:
- Download GeoIP Database and place it to
./assets/geoip. (see ./internal/ip/geo/geoip.go). - Pepare your MySQL/MariaDB.
- Copy
.env.exampleto.envand edit it to match with server environment. - Build the binary with
make server(ormake buildto build both server and client binaries). - Run the service with
./bin/xmr-nodes-server-linux-<YOUR_CPU_ARCH> serve.
Systemd example: xmr-nodes-server.service.
For initial prober setup:
- Create API key for prober
- Copy
.env.exampleto.envand edit it to match with prober environment. - Build the binary with
make client(ormake buildto build both server and client binaries). - Run the service with
./bin/xmr-nodes-client-linux-<YOUR_CPU_ARCH> probe.
Systemd example: xmr-nodes-prober.service and xmr-nodes-prober.timer.
Development and Deployment
- Clone or fork this repository.
- Prepare the assets:
make prepare, - Run
air serve(live reload using air-verse/air).
See the Makefile.
ToDo's
- ✅ Accept IPv6 nodes.
- Use
a-h/templandHTMXinstead ofSvelte. - Use Go standard
net/httpinstead offiber.
Acknowledgement
The creators and contributors of these projects have provided valuable resources, which I am grateful for:
Similar Projects
Donation
The servers costs are currently covered by myself. If you find this project
useful, please consider making a donation to help cover the ongoing expenses.
Your contribution will go towards ensuring the continued availability of the
website and my stagenet and testnet public remote nodes.
XMR Donation address:
8BWYe6GzbNKbxe3D8mPkfFMQA2rViaZJFhWShhZTjJCNG6EZHkXRZCKHiuKmwwe4DXDYF8KKcbGkvNYaiRG3sNt7JhnVp7D
Thank you!
License
This project is licensed under GLWTPL.