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
291 commits 3 branches 40 tags 1.5 MiB
Find a file
Exact
imterah 862f307e56
All checks were successful
Release code / build (push) Successful in 9m48s
Details
fix: Fixes documentation and migration code.
2024-12-26 14:59:01 -05:00
.devcontainer fix: Reorders files again. 2024-04-28 14:32:38 -04:00
.forgejo/workflows fix: Change packages server to GitHub. 2024-12-25 20:19:01 -05:00
.githooks chore: Clean up usage of git commands in git hooks. 2024-06-02 11:24:53 -04:00
.vscode fix: Fixes vscode settings. 2024-12-22 11:35:57 -05:00
backend fix: Fixes documentation and migration code. 2024-12-26 14:59:01 -05:00
backend-legacy feature: Adds migration Docker image. 2024-12-25 20:00:16 -05:00
docs fix: Fixes documentation and migration code. 2024-12-26 14:59:01 -05:00
routes/Hermes API feature: Adds autostart support. 2024-12-23 22:03:59 -05:00
sshfrontend chore: Restructure files. 2024-12-21 18:27:40 -05:00
.gitconfig chore: Adds formatting. 2024-05-05 16:59:08 -04:00
.gitignore feature: Adds backup importing support. 2024-12-25 19:21:22 -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 chore: Adds documentation. 2024-12-26 14:37:38 -05:00
init.sh fix: Fixes initializing script for backend-legacy. 2024-12-22 10:31:38 -05:00
LICENSE Initial commit 2024-04-16 09:03:21 -04:00
migration-entrypoint.sh feature: Adds migration Docker image. 2024-12-25 20:00:16 -05:00
MigrationDockerfile feature: Adds migration Docker image. 2024-12-25 20:00:16 -05: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 chore: Bumps dependencies, rewrites development environment system. 2024-12-01 13:06:28 -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.