npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

onyx-server

v0.5.0

Published

PSS mailboxing service

Downloads

22

Readme

Onyx Server

Mailboxing & data service for the Onyx app.

Prerequisites

Node v8+ with npm.

Installation

npm install --global onyx-server

Usage

CLI

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 variables ONYX_PORT, SWARM_HTTP_URL and SWARM_WS_URL or its defaults (WebSocket on ws://localhost:8546, HTTP on http://localhost:8500 and port 5000).

Additionally you can pass -u or --unsecure to dismiss using TLS, only recommended for when connecting client and server over a local connection

The DEBUG environment variable can be used to activate logs, ex:

DEBUG="onyx*" onyx-server

Connection security

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>

Development

To build local version run yarn build. Afterwards you can start the built server with yarn start.

Onyx server depends on having a local swarm node running. You can start it by running the start_swarm_node.sh script. This should allow you to run onyx-server with no special arguments.

in one shell:

./scripts/start_swarm_node.sh <some_swarm_data_directory_here>

in another shell:

yarn start

API

import Conf from 'conf'
import startServer from 'onyx-server'

startServer({
  httpUrl: 'http://localhost:8500',
  wsUrl: 'ws://localhost:8546',
  port: 5000,
  store: new Conf(),
}).then(
  server => {
    console.log('server started')
  },
  err => {
    console.log('failed to start server', err)
  },
)

All parameters are optional, fallback values will be used for the parameters not provided.

License

MIT.
See LICENSE file.