imterah/hermes
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 1 Packages Wiki Activity Actions
hermes/README.md
greysoh 7b5ec36e61
Some checks failed
CI Testing (API) / test (push) Waiting to run
Details
CI Testing (LOM) / test (push) Has been cancelled
Details
chore: Update README with new development information.
2024-12-01 13:08:38 -05:00

1.8 KiB
Raw Blame History

NextNet

built with nix License Badge


NextNet is a dashboard to manage portforwarding technologies.

Local Development

Note

Using nix is recommended. If you're not using Nix, install the Go language & language server (go & gopls), Node.JS, and lsof.

  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. Here be dragons!

  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 the 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.