The backend for Hymenia, a new open-source BYOC (bring your own client) platform for messaging and VoIP calls. We are nowhere near finished!
Run from this folder:
- Install deps
pnpm install- Set env
Copy .env.example to .env and adjust if needed:
cp .env.example .envConfigure passkeys:
Set WEBAUTHN_RP_ID to the hostname users open in their browser and set
WEBAUTHN_ORIGIN to a comma-separated list of allowed client origins, including
the scheme and port. For a Tauri desktop client, include tauri://localhost
and http://tauri.localhost so packaged apps can use passkeys on Linux, macOS,
and Windows. Set the browser origin and RP ID for your deployed website as well.
If you don't want email verification on your instance, you can disable it by setting
DISABLE_EMAIL_VERIFICATION to true in .env. We reccomend doing this if your instance is meant for a small amount of people, for example you could have an instance for Food and the spaces are all on different foods.
Set INSTANCE_NAME and PUBLIC_URL to describe this server. PUBLIC_URL must
be its public HTTP or HTTPS origin. The server creates a stable instance ID in
the database on first startup and publishes this information at
/.well-known/hymenia. Keep the database when backing up or moving an instance
to preserve its ID.
- Apply schema
The server applies schema.sql each time it starts. Keep its statements safe to
run repeatedly when changing the schema.
- Start server
pnpm startCheck that the server is responding:
curl -k https://127.0.0.1:9070/healthUse curl http://127.0.0.1:9070/health when TLS certificate files are not
configured. The server needs PostgreSQL running at the DATABASE_URL address
before authenticated API calls can read or write data.
The server listens on all interfaces. From another device, use
http://<ip>:9070/health. Allow TCP port 9070 through your
firewall when needed.
Run the server unit tests with pnpm test. They use Node's built-in test runner
and do not require a running database.
Tests don't exist for now as they aren't finished and I probably won't finish them any time soon
Attachments are limited to 20 MB, written to ATTACHMENTS_DIR when set (or
server/uploads by default), and linked to messages in PostgreSQL.
Hymenia Server is free and open source software released under the MIT License.