hermes/README.md

Hermes

Port forwarding across boundaries.

Local Development

Note

Using Nix is recommended for the development environment. If you're not using it, install Go and NodeJS. Using Docker is required for database configuration.

1. First, make sure you have a sane copy of Docker installed, and make sure the copy of Docker works.

2. Secondly, check if you have a working Nix environment if you're using Nix.

3. Lastly, Run nix-shell, or alternatively source init.sh if you're not using Nix.

API Development

1. After that, run the project in development mode: npm run dev.

2. If you want to explore your database, run npx prisma studio to open the database editor.

Production Deployment

Warning

Deploying using Docker Compose is the only officially supported deployment method.

1. Copy and change the default password (or username & db name too) from the template file prod-docker.env:

sed "s/POSTGRES_PASSWORD=nextnet/POSTGRES_PASSWORD=$(head -c 500 /dev/random | sha512sum | cut -d " " -f 1)/g" prod-docker.env > .env

2. Build the docker stack: docker compose --env-file .env up -d

Troubleshooting

• I'm using SSH tunneling, and I can't reach any of the tunnels publicly.

  • Be sure to enable GatewayPorts in your sshd config (in /etc/ssh/sshd_config on most systems). Also, be sure to check your firewall rules on your system and your network.