Arweave Gateway

Requirements

1. A Unix OS

2. Docker and Docker Compose LTS

There is also the development version of the guide, that you can review here.

Environment

By default, there is a default environment you can use located at .env.docker in the repository.

ARWEAVE_NODES=["..."]

DATABASE_HOST=postgres
DATABASE_PORT=5432
DATABASE_USER=arweave
DATABASE_PASSWORD=arweave
DATABASE_NAME=arweave

ENVIRONMENT=public
PORT=3000

PARALLEL=8

INDICES=["app-name", "domain", "namespace"]

Make sure you copy this configuration to .env.

cp .env.docker .env

Compilation

You can start the server with docker-compose.

# with npm
npm run docker:start

# with yarn
yarn docker:start

# with pure docker-compose
docker-compose up --build -d

You can spin down the docker-compose cluster with.

# with npm
npm run docker:stop

# with yarn
yarn docker:stop

# with pure docker-compose
docker-compose down -v

Testing

You can test if the server and the GraphQL queries are working properly by navigating to.

http://localhost:3000/graphql

This webpage should look similar to.

https://arweave.dev/graphql