Skip to content

Commit

Permalink
FOrmatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jamiehewitt15 committed Aug 15, 2024
1 parent 0602cfc commit aa92a31
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ We recommend the following minimum requirements, although you may be be able to

Build and run the node using Docker:

1. **Build the Docker image:**
`docker build -t ocean-node:mybuild .`

2. **Run the Docker container:**
`docker run -e PRIVATE_KEY=your_private_key_here ocean-node:mybuild`
```bash
docker build -t ocean-node:mybuild . # Build the Docker image
docker run -e PRIVATE_KEY=your_private_key_here ocean-node:mybuild # Run the Docker container
```

## Option 2: Running Ocean Nodes with PM2

Expand Down Expand Up @@ -64,7 +63,9 @@ pm2 delete ocean-node # Delete the process

### 1. Start the Typesense database

`docker-compose -f typesense-compose.yml up -d`
```bash
docker-compose -f typesense-compose.yml up -d
```

### 2. Install dependencies & build the project

Expand All @@ -89,13 +90,17 @@ source .env

Manually set the required environment variables:

`export PRIVATE_KEY="your_private_key_here"`
```bash
export PRIVATE_KEY="your_private_key_here"
```

The `PRIVATE_KEY` is the only mandatory environmental variable. Additional configurations can be set as needed. For all available configurations, refer to the [Environment Variables](docs/env.md) documentation.

### 5. Start the Node

`npm run start`
```bash
npm run start
```

Your node is now running, the dashboard will be available at `http://localhost:8000/dashboard/`. To start additional nodes, repeat these steps in a new terminal.

Expand Down

0 comments on commit aa92a31

Please sign in to comment.