@ -51,17 +51,28 @@ Usage:
Options :
Options :
-- help , - h Show this help message
-- help , - h Show this help message
MONOLITHIC MODE ( default ) :
By default , the relay runs as a single self - contained binary with all
components embedded :
- Embedded Badger database ( or Neo4j if configured )
- Embedded ACL engine ( follows , managed , or curating modes )
- Embedded NIP - 77 negentropy sync ( when ORLY_NEGENTROPY_ENABLED = true )
This is the simplest deployment - just run ' orly ' and everything works .
The relay is the main Nostr server that :
The relay is the main Nostr server that :
- Accepts WebSocket connections from clients
- Accepts WebSocket connections from clients
- Processes EVENT , REQ , and other Nostr messages
- Processes EVENT , REQ , and other Nostr messages
- Stores events in the database ( direct or via gRPC )
- Stores events in the database ( embedded or via gRPC )
- Enforces ACL policies ( direct or via gRPC )
- Enforces ACL policies ( embedded or via gRPC )
- Handles NIP - 77 negentropy set reconciliation ( embedded or via gRPC )
Environment variables :
Environment variables :
ORLY_PORT Server port ( default : 3334 )
ORLY_PORT Server port ( default : 3334 )
ORLY_LOG_LEVEL Logging level
ORLY_LOG_LEVEL Logging level
ORLY_DB_TYPE Database type : badger , neo4j , grpc ( default : badger )
ORLY_DB_TYPE Database type : badger , neo4j , grpc ( default : badger )
ORLY_ACL_MODE ACL mode : none , follows , managed , curating ( default : none )
ORLY_ACL_MODE ACL mode : none , follows , managed , curating ( default : none )
ORLY_NEGENTROPY_ENABLED Enable NIP - 77 negentropy sync ( default : false )
ORLY_TLS_DOMAINS Let ' s Encrypt domains
ORLY_TLS_DOMAINS Let ' s Encrypt domains
ORLY_AUTH_TO_WRITE Require auth for writes
ORLY_AUTH_TO_WRITE Require auth for writes
@ -78,9 +89,13 @@ gRPC Backend Configuration (for split-mode deployment):
ORLY_GRPC_SYNC_CLUSTER Cluster sync address ( default : 127.0 .0 .1 : 50054 )
ORLY_GRPC_SYNC_CLUSTER Cluster sync address ( default : 127.0 .0 .1 : 50054 )
Examples :
Examples :
orly Start relay ( monolithic mode )
# Monolithic mode ( all components embedded in single binary )
orly relay Start relay ( explicit )
orly Start relay with embedded DB + ACL
ORLY_DB_TYPE = grpc orly Connect to gRPC database at 127.0 .0 .1 : 50051
ORLY_NEGENTROPY_ENABLED = true orly Enable NIP - 77 negentropy sync
ORLY_ACL_TYPE = grpc orly Connect to gRPC ACL at 127.0 .0 .1 : 50052
ORLY_ACL_MODE = follows orly Use follows - based whitelist ACL
# Split mode ( separate gRPC services )
ORLY_DB_TYPE = grpc orly Connect to gRPC database
ORLY_ACL_TYPE = grpc orly Connect to gRPC ACL
ORLY_DB_TYPE = grpc ORLY_ACL_TYPE = grpc orly Full split mode ` )
ORLY_DB_TYPE = grpc ORLY_ACL_TYPE = grpc orly Full split mode ` )
}
}