Running the SimplePage Node
Contribute to the health of the Simple Page network by running your own indexer node:
Prerequisites
- Node.js 20+ with ES modules support
- IPFS node (Kubo) running and accessible
- Ethereum RPC endpoint
Installation
npm install -g @simplepg/dservice
Basic Setup
# Start with default settings
simplepage-dservice
# Start with custom configuration
simplepage-dservice \
--ipfs-api http://localhost:5001 \
--api-port 3000 \
--rpc https://mainnet.infura.io/v2/YOUR_KEY \
--chain-id 1
For a full list of options and commands, see simplepage-dservice --help.
Kubo Best Practices
When starting your Kubo IPFS node, it is recommended that you use the following functionality:
- AutoTLS - gives your node a TLS certificate to make it accessible from web browsers
- AcceleratedDHTClient - makes the connectivity of your node better, at the cost of some CPU overhead
Allow/Block List Management
The Node implementation has support for allow-/block-listing pages based on domains. This can be useful if there is certain content you know you don't want your node to index, or certain pages you ONLY want to index.
# Manage allow list
simplepage-dservice allow-list show
simplepage-dservice allow-list add example.eth
simplepage-dservice allow-list rm example.eth
# Manage block list
simplepage-dservice block-list show
simplepage-dservice block-list add spam.eth
simplepage-dservice block-list rm spam.eth
Benefits of Running a Node
- Network Health: Help ensure content availability
- Censorship Resistance: Contribute to decentralized hosting
- Community Support: Support the Simple Page ecosystem
- Custom Control: Host your own content and trusted sites
- Potential Rewards: While not currently the case, as the Simple Page grows, node runners might be eligable for rewards through incentive programs
Get Involved
If you are intending to run a node in a professional manner, please reach out on our Matrix chat. There's an opportunity to get listed as an official node, and get potential future rewards.