imterah/hermes
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases 1 Packages Wiki Activity Actions

chore: Update README with new development information.
Some checks failed
CI Testing (API) / test (push) Waiting to run
Details
CI Testing (LOM) / test (push) Has been cancelled
Details

Browse source
This commit is contained in:
greysoh 2024-12-01 13:08:38 -05:00
parent 0965c56547
commit 7b5ec36e61
Signed by: imterah
GPG key ID: 8FA7DD57BA6CEA37
1 changed files with 8 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -12,11 +12,13 @@
<h2 align="center">Local Development</h2> <h2 align="center">Local Development</h2>
> [!NOTE] > [!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.
<h3 align="center">API Development</h3> <h3 align="center">API Development</h3>
@ -26,18 +28,18 @@
<h2 align="center">Production Deployment</h2> <h2 align="center">Production Deployment</h2>
> [!WARNING] > [!WARNING]
> Deploying using docker compose is the only officially supported deployment method. Here be dragons! > 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`: 1. Copy and change the default password (or username & db name too) from the template file `prod-docker.env`:
```bash ```bash
sed "s/POSTGRES_PASSWORD=nextnet/POSTGRES_PASSWORD=$(head -c 500 /dev/random | sha512sum | cut -d " " -f 1)/g" prod-docker.env > .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` 2. Build the docker stack: `docker compose --env-file .env up -d`
<h2 align="center">Troubleshooting</h2> <h2 align="center">Troubleshooting</h2>
* I'm using the SSH tunneling, and I can't reach any of the tunnels publicly. * 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. - 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.