imterah/hermes
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 1 Packages Wiki Activity Actions
Hermes is a toolset to port forward across boundaries
%!d() commits 3 branches 40 tags 1.5 MiB
Find a file
greysoh d1d3a31335
chore: Changes changelog system. 
Co-authored-by: dess <devessa@users.noreply.github.com>
2024-05-05 18:53:33 -04:00
.devcontainer fix: Reorders files again. 2024-04-28 14:32:38 -04:00
.githooks chore: Adds base template for nextnet LOM. 2024-05-05 18:36:23 -04:00
.github chore: Changes changelog system. 2024-05-05 18:53:33 -04:00
.vscode chore: Adds .vscode folder. 2024-04-28 14:42:56 -04:00
api chore: Format code again. 2024-05-05 17:03:24 -04:00
gui chore: Adds formatting. 2024-05-05 16:59:08 -04:00
lom chore: Adds base template for nextnet LOM. 2024-05-05 18:36:23 -04:00
.gitconfig chore: Adds formatting. 2024-05-05 16:59:08 -04:00
.gitignore feature: Adds hello world for gui. 2024-04-28 14:36:51 -04:00
.prettierrc chore: Adds formatting. 2024-05-05 16:59:08 -04:00
docker-compose.yml chore: Use built package instead of building from source. 2024-05-04 19:30:50 -04:00
init.sh chore: Adds formatting. 2024-05-05 16:59:08 -04:00
LICENSE Initial commit 2024-04-16 09:03:21 -04:00
prod-docker.env chore: Move docker production env file. 2024-04-28 14:24:46 -04:00
README.md chore: Use built package instead of building from source. 2024-05-04 19:30:50 -04:00
shell.nix chore: Adds formatting. 2024-05-05 16:59:08 -04:00
VERSION ci: add builder 2024-05-04 19:09:10 -04:00

README.md

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 PostgreSQL, Node.JS, and lsof.

  1. First, check if you have a working Nix environment if you're using Nix.

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