chore: Adds documentation.

docs/nextnet_to_hermes_migration.md

@@ -0,0 +1,28 @@
+# NextNet to Hermes migration
+## Other Environment Variables
+Below are existing environment variables that need to be migrated over from NextNet to Hermes, untouched:
+  * `IS_SIGNUP_ENABLED` -> `HERMES_SIGNUP_ENABLED`
+  * `UNSAFE_ADMIN_SIGNUP` -> `HERMES_UNSAFE_ADMIN_SIGNUP_ENABLED`
+Below are new environment variables that may need to be set up:
+  * `HERMES_FORCE_DISABLE_REFRESH_TOKEN_EXPIRY`: Disables refresh token expiry for Hermes. Instead of the singular token structure used
+    by NextNet, there is now a refresh token and JWT token combination.
+  * `HERMES_LOG_LEVEL`: Log level for Hermes & Hermes backends to run at.
+  * `HERMES_DEVELOPMENT_MODE`: Development mode for Hermes, disabling security features.
+  * `HERMES_LISTENING_ADDRESS`: Address to listen on for the API server. Example: `0.0.0.0:8000`.
+  * `HERMES_TRUSTED_HTTP_PROXIES`: List of trusted HTTP proxies separated by commas.
+## Database-Related Environment Variables
+  * `HERMES_DATABASE_BACKEND`: Can be either `sqlite` for the embedded SQLite-compliant database, or `postgresql` for PostgreSQL support.
+  * `HERMES_SQLITE_FILEPATH`: Path for the SQLite database to use.
+  * `HERMES_POSTGRES_DSN`: PostgreSQL DSN for Golang. An example value which should work with minimal changes for PostgreSQL databases is `postgres://username:password@localhost:5432/database_name`.
+## Migration steps
+1. Add the supporting environment variable for Prisma: `DATABASE_URL` -> `postgresql://$POSTGRES_USERNAME:$POSTGRES_PASSWORD@nextnet-postgres:5432/$POSTGRES_DB`.
+2. Remove all old environment variables.
+3. Add these variables:
+  - `HERMES_DATABASE_BACKEND` -> `postgresql`
+  - `HERMES_POSTGRES_DSN` -> `postgres://$POSTGRES_USERNAME:$POSTGRES_PASSWORD@nextnet-postgres:5432/$POSTGRES_DB`
+  - `DATABASE_URL` -> `postgresql://$POSTGRES_USERNAME:$POSTGRES_PASSWORD@nextnet-postgres:5432/$POSTGRES_DB?schema=nextnet`
+4. Switch the API docker image from `ghcr.io/imterah/nextnet:latest` to `ghcr.io/imterah/hermes-backend-migration:latest`
+5. Go get the container logs, and make sure no errors get output to the console.
+6. Copy the backup as instructed in the log file.
+7. DO NOT RESTART THE CONTAINER IF SUCCESSFUL. YOU WILL LOSE ALL YOUR DATA. If the migration fails, follow the steps mentioned in the logs.
+8. If successful, switch the API docker image from `ghcr.io/imterah/hermes-backend-migration:latest` to `ghcr.io/imterah/hermes:latest`.

docs/troubleshooting.md

@@ -0,0 +1,4 @@
+# Troubleshooting
+
+* I'm using 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.