oceanprotocol / ocean-node

Ocean Nodes Ocean Nodes run everything you need in the Ocean stack, they replace three previous components: Provider, Aquarius and subgraph. This is a minimal guide to quickly start and run an Ocean Node. See the docs directory for more detailed information on Ocean Nodes and how to customise your setup. **Note: this repository is currently excluded from all bug bounty programs.** System requirements We recommend the following minimum requirements, although you may be be able to run a node with less (depending on your configuration). • 1vcpu • 2 GB ram • 4 GB storage • OS: we recommend using the latest LTS version of Ubuntu or the latest macOS. However, the nodes should also work on other operating systems including Windows. Option 1: Running Ocean Nodes in Docker (recommended) This readme is the recommended way to host a node and be eligible for incentives. The other options are more recommended towards developers that want to tinker. Option 2: Running local build of Ocean Nodes in Docker Run the following script to deploy node: This command will run you through the process of setting up the environmental variables for your node. > [!NOTE] > The quickstart script attempts to automatically detect GPUs (NVIDIA via , others via ) and appends them to your . > If you choose to manually configure before running the script (e.g. via environment variable), be aware that auto-detected GPUs will be **merged** into your configuration, which could lead to duplication if you already manually defined them. > For most users, it is recommended to let the script handle GPU detection automatically. Option 3: Running Ocean Nodes with PM2 PM2 is a process manager that makes it easy to manage and monitor your Node.js applications. • Install PM2 • Setup the environmental variables Either use the script: or setup the required environment variables manually: The is the only mandatory environmental variable, you must include the at the front of your private key. Additional configurations can be set as needed. For all available configurations, refer to the Environment Variables documentation. 2.1. If the config is a JSON file, run: Config file should be absolute path. • Quick start the Ocean Node with PM2 • Monitor and Manage the Node You can use the following PM2 commands to manage your Ocean Node: Option 3: Running Ocean Nodes With NPM Prerequisites • **Node Version:** Install the node version specified in . • **Docker** • **Docker compose** • **nvm** (recommended but not necessary) • Start the Typesense database • Install dependencies & build the project • Configure Environment Variables Option 1: Automatic Setup (Recommended) Run the helper script to generate and set up the minimum required environment variables: Option 2: Manual Setup Manually set the required environment variables: The is the only mandatory environmental variable, you must include the at the front of your private key. Additional configurations can be set as needed. For all available configurations, refer to the Environment Variables documentation. • Start the Node Your node is now running. To start additional nodes, repeat these steps in a new terminal. Additional Resources • Ocean Nodes Architecture • API Endpoints • Environmental Variables • Database Guide • Storage Types • Testing Guide • Network Configuration • Logging & accessing logs • Docker Deployment Guide • C2D GPU Guide • Compute pricing