The pool software is still in development, expect bugs and incomplete features.
Experimental: Specifications are subject to change.
Requirements
- An host with docker installed and configured
- Basic knowledge on how to use a terminal and docker
- The link to a public nostr relay (eg.
wss://nostr.openagents.com:7777
)
The pool host need to be accessible from the nodes that you wish to connect.
However it is not necessary to make it publicly accessible to the internet, since pool2pool and user2pool communication happens over nostr
Install and run with docker
To run the OpenAgents pool you can use the following docker command:-p5021:5021
and the POOL_GRPC_BINDING_PORT
environment variable.
By default the pool will create a random nostr secret key to authenticate with the network.
If you want you can provide a custom secret key by addingto the docker command.
To enable SSL you can add the following to the docker command:You will need to ensure you have valid certificates in the folder, you can use letsencrypt to get free certificates.
docker logs --follow openagents-pool
to see if everything is working correctly.
To learn how to setup a basic rag pipeline check the Setting up a RAG pipeline page.