From f9d648256aa295aae62c88498cd5f380465351c4 Mon Sep 17 00:00:00 2001 From: imterah Date: Sat, 21 Dec 2024 18:07:53 -0500 Subject: [PATCH] chore: Reword and rename things. --- README.md | 23 ++++++++++++----------- dev-docker-compose.yml | 2 +- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b1cb5a0..9173740 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,19 @@ -

NextNet

+

Hermes

- built with nix - License Badge + Docker Badge + Golang Badge + License Badge


-**NextNet is a dashboard to manage portforwarding technologies.** - +**Port forwarding across boundaries.**

Local Development

> [!NOTE] -> Using [nix](https://builtwithnix.org) is recommended. If you're not using Nix, install the Go language & language server (`go` & `gopls`), Node.JS, and `lsof`. +> Using [Nix](https://builtwithnix.org) is recommended for the development environment. If you're not using it, install Go and NodeJS. + Using [Docker](https://www.docker.com/) 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. @@ -29,17 +30,17 @@

Production Deployment

> [!WARNING] -> Deploying using docker compose is the only officially supported deployment method. Here be dragons! +> Deploying using [Docker Compose](https://docs.docker.com/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`: - ```bash - sed "s/POSTGRES_PASSWORD=nextnet/POSTGRES_PASSWORD=$(head -c 500 /dev/random | sha512sum | cut -d " " -f 1)/g" prod-docker.env > .env - ``` + ```bash + 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. +* 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. diff --git a/dev-docker-compose.yml b/dev-docker-compose.yml index f7f34d5..c5ede8a 100644 --- a/dev-docker-compose.yml +++ b/dev-docker-compose.yml @@ -5,7 +5,7 @@ services: postgres: image: postgres:17.2 - container_name: nextnet-postgres + container_name: hermes-postgres restart: always environment: POSTGRES_DB: nextnet