Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xGov-110 - Pixelnode: One-click node manager #110

Merged
merged 10 commits into from
Feb 7, 2024
91 changes: 91 additions & 0 deletions Proposals/xgov-110.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
id: 110
period: 3
title: Pixelnode - Oneclick node manager
author: Shivaprasad Manupadi (@shivamanupadi)
discussions-to: https://forum.algorand.org/t/xgov-110-pixelnode-one-click-node-manager/11211
company_name: Pixelnode
category: Tools
focus_area: Node
open_source: No
amount_requested: 250000
status: Final
---

## Abstract

PixelNode is a user-friendly One-click node solution for Algorand node management.
Offering a seamless installation process and an intuitive web interface for easy interaction with Algorand nodes.

## Team

Shivaprasad - Developer
- 10 years of experience in building web applications.
- Core expertise in TypeScript & MongoDB.

## Experience with Algorand

Involved in the development of AlgoDesk, DappFlow, and PixelNode, contributing to the Algorand ecosystem over the past 2 years.

## Present Proposal

### Installation & Setup
1. Install an Algorand node using one command.
2. Set up authentication credentials using the PixelNode setup interface.

### Dashboard
1. View system hardware configuration (OS, Storage, and RAM).
2. Install a node for any network (Mainnet, Testnet & Betanet).
3. Display catchup details during the catchup phase.
4. Options to uninstall or restart a running node.
5. Initiate force catchup if the node is stuck.
6. Show live blocks & stakes of participating accounts.

### MyNode
1. Display network details and Algod configuration.
2. Swagger interface for Algod API.
3. Display CPU usage of the installed node.
4. Update your node to the latest version with a single click.
5. Enable/Disable metrics with a single click.
6. View metrics using Prometheus graphs or Grafana dashboards on the same PixelNode instance.
7. Enable/Disable telemetry.
8. Configure telemetry name.

### Participation keys
1. View the list of participation keys with details.
2. Generate new participation keys.
3. Sign newly generated participation keys using the PixelNode console.
4. Delete a participation key.

### Settings
1. Public status page to see the status of the PixelNode instance.
2. Update PixelNode with a single click if a new version is released.
3. Restart your PixelNode instance.
4. Factory reset PixelNode.
5. Setup Env variables GOGC=50, GOMEMLIMIT=90% of memory by install/upgrade script
6. Ability to download PM2 logs and DMESG logs to debug incase of node crash.


## Future Blueprint

Plans for future releases (Not part of this milestone):

1. Improve stability before node incentives go live.
2. System monitor to check CPU usage, Disk usage, etc. (probably use netdata)
3. Display Mempool.
4. Ship out-of-the-box Grafana dashboards for node metrics.


## Benefits for the community

People without technical knowledge can self-host Algorand nodes and manage participation keys effortlessly.

## Additional information
Installation command:
```sudo curl -L http://get.pixelnode.org | sudo bash```

Links:

* https://www.pixelnode.org
* https://twitter.com/pixelnode_
* https://discord.gg/HeegumVJwb
Loading