Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.08 KB

getting-started.md

File metadata and controls

65 lines (44 loc) · 2.08 KB
Raw

🚀 Getting Started

Installation

There are three methods for setting up a local Redwood node.

Download from Github

Pre-compiled binaries are available for all platforms (Mac, Linux, Windows) at https://github.com/redwood/redwood/releases. These binaries are built via Github Actions, although this does not guarantee that they are safe to use.

Docker

Docker images are available both for the Redwood node as well as the "static relay" node (see the section on peer-to-peer communications to learn about relays).

First, install Docker with the official instructions. Then, pull the image:

docker pull redwoodp2p/redwood

Build from source

Requires Go 1.18. See the following resources to install Go:

Once Go is set up, run the following commands to clone the repository and build the Redwood binary:

git clone https://github.com/redwood/redwood
cd redwood/embed
yarn && yarn build
cd ../cmd/redwood
go build .

Running the node

Regular binary

Redwood accepts several command-line flags:

-c, --config            location of config file      (required)
-p, --password-file     location of password file    (required)
-k, --libp2p-key-file   location of libp2p key file
--gui                   enable terminal UI

Most of the time, however, you will only need to specify -c and -p.

Docker

To run Redwood in Docker, use the following command, making sure to replace <local data dir> with the location on the host machine where you wish to persist Redwood's configuration and data:

docker run -it \
        -p 21232:21231 \
        -v <local data dir>/config:/config \
        -v <local data dir>/data:/root/.local/share/redwood \
        -v <local data dir>/nurse:/nurse \
        redwoodp2p/redwood \
        /redwood -p /config/password.txt -c /config/.redwoodrc