From 7b5ec36e614c07a697cf768f63864ab5773a56c2 Mon Sep 17 00:00:00 2001 From: greysoh Date: Sun, 1 Dec 2024 13:08:38 -0500 Subject: [PATCH] chore: Update README with new development information. --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ded45f1..b1cb5a0 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,13 @@

Local Development

> [!NOTE] -> Using [nix](https://builtwithnix.org) is recommended. If you're not using Nix, install PostgreSQL, Node.JS, and `lsof`. +> 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`. -1. First, check if you have a working Nix environment if you're using Nix. +1. First, make sure you have a sane copy of Docker installed, and make sure the copy of Docker works. -2. Run `nix-shell`, or alternatively `source init.sh` if you're not using Nix. +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

@@ -26,18 +28,18 @@

Production Deployment

-> [!WARNING] +> [!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`: ```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. - - 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. \ No newline at end of file + - 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.