Mailboxing & data service for the Onyx app.
npm install --global onyx-server
onyx-server --port 5000 --http-url http://localhost:8500 --ws-url ws://localhost:8546
All arguments are optional, when not provided the server will use environment
SWARM_WS_URL or its defaults
ws://localhost:8546, HTTP on
http://localhost:8500 and port
Additionally you can pass
--unsecure to dismiss using TLS, only recommended
for when connecting client and server over a local connection
DEBUG environment variable can be used to activate logs, ex:
The Onyx client connects to Onyx server using a WebSocket, and so uses TLS certificates to authenticate and encrypt the connection. Use of client certificates is enforced so that only your clients with the correct certificate will be allowed to connect to the server, others are rejected. For mobile clients, where it can be more difficult to handle cert files, the server allows clients accessing the cert endpoint to download a password-encrypted p12 client cert. For convenience, you can use the provided script to generate a set of unique self-signed certificates.
./scripts/gen-certs.sh -p <certificate-password> -i <ip-address-to-certify> -d <domain-to-certify>
To build local version run
yarn build. Afterwards you can start the built server
Onyx server depends on having a local swarm node running. You can start it by running
start_swarm_node.sh script. This should allow you to run
no special arguments.
in one shell:
in another shell:
All parameters are optional, fallback values will be used for the parameters not provided.
See LICENSE file.