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
imterah ede4d528aa
feature: Adds basic backend starting for sshappbackend.
2025-01-27 07:36:29 -05:00
.devcontainer fix: Fixes more instability issues. :) 2025-01-08 09:12:48 -05:00
.forgejo/workflows fix: Fixes action workflows. 2025-01-09 08:00:37 -05:00
.vscode fix: Fixes vscode settings. 2024-12-22 11:35:57 -05:00
apiclient chore: Adds login and user creation support to the API. 2025-01-05 20:51:06 -05:00
backend feature: Adds basic backend starting for sshappbackend. 2025-01-27 07:36:29 -05:00
docs feature: Add profiling documentation for backends based on BackendUtil. 2025-01-10 16:23:26 -05:00
frontend chore: Adds login and user creation support to the API. 2025-01-05 20:51:06 -05:00
routes/Hermes API fix: Fixes more instability issues. :) 2025-01-08 09:12:48 -05:00
.gitignore feature: Adds basic backend starting for sshappbackend. 2025-01-27 07:36:29 -05:00
.prettierrc chore: Adds formatting. 2024-05-05 16:59:08 -04:00
CHANGELOG.md chore: Update changelog for tag v1.1.2. 2024-09-29 13:03:38 +00:00
docker-compose.yml feature: Fixes all backup and API related things to make everything work in production. 2024-12-26 22:54:05 -05:00
Dockerfile fix: Fixes action workflows. 2025-01-09 08:00:37 -05:00
go.mod feature: Adds basic backend starting for sshappbackend. 2025-01-27 07:36:29 -05:00
go.sum feature: Adds basic backend starting for sshappbackend. 2025-01-27 07:36:29 -05:00
init.sh chore: Adds login and user creation support to the API. 2025-01-05 20:51:06 -05:00
LICENSE Initial commit 2024-04-16 09:03:21 -04:00
prod-docker.env chore: Adds documentation. 2024-12-26 14:37:38 -05:00
README.md chore: Adds documentation. 2024-12-26 14:37:38 -05:00
shell.nix fix: Fixes rare errors regarding Nix shell not finding the initialization script. 2024-12-28 15:41:05 -05:00

README.md

Hermes

Docker Badge Golang Badge License Badge (licensed under BSD-3-Clause)

Port forwarding across boundaries.

Local Development

Note

Using Nix is recommended for the development environment. If you're not using it, install Go. For legacy maintence tasks, install NodeJS.

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

  2. Secondly, Run nix-shell, or alternatively source init.sh if you're not using Nix.

API Development

  1. After that, run the backend build script: ./build.sh.

  2. Then, go into the api/ directory, and then start it up: go run . -b ../backends.dev.json

Production Deployment

Warning

Deploying using Docker 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:
sed "s/POSTGRES_PASSWORD=hermes/POSTGRES_PASSWORD=$(head -c 500 /dev/random | sha512sum | cut -d " " -f 1)/g" prod-docker.env > .env
  1. Build the docker stack: docker compose --env-file .env up -d

Troubleshooting

This has been moved here.

Documentation

Go to the docs/ folder.