Hermes is a toolset to port forward across boundaries
imterah
538c5b6c51
All checks were successful
Release code / build (push) Successful in 11m41s
This fixes database error reporting, as well as majorly fixes users not being able to authenticate to the API if you used the automated migration setup, as the password would remain in hex encoding. We now decode the hexadecimal and then change it to the far more compact base64 encoding before adding it to the database. This should fix login, and not cause 500 Interal Server Errors anymore. Sorry folks! |
||
|---|---|---|
| .devcontainer | ||
| .forgejo/workflows | ||
| .githooks | ||
| .vscode | ||
| backend | ||
| backend-legacy | ||
| docs | ||
| routes/Hermes API | ||
| sshfrontend | ||
| .gitconfig | ||
| .gitignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| docker-compose.yml | ||
| init.sh | ||
| LICENSE | ||
| migration-entrypoint.sh | ||
| MigrationDockerfile | ||
| prod-docker.env | ||
| README.md | ||
| shell.nix | ||
Hermes
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.
-
Firstly, check if you have a working Nix environment if you're using Nix.
-
Secondly, Run
nix-shell, or alternativelysource init.shif you're not using Nix.
API Development
-
After that, run the backend build script:
./build.sh. -
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.
- 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
- Build the docker stack:
docker compose --env-file .env up -d
Troubleshooting
This has been moved here.
Documentation
Go to the docs/ folder.