Publish Your Own Streams

Publishing puts your data on a stream for anyone to subscribe to. It needs a free account.

Sign up and add your key

1. Create a free account at hypermass.io.
2. Create an access key at hypermass.io/access-keys.
3. Run hypermass login and paste the key in.
4. Restart hypermass sync, which reads the key when it starts.

More on keys: Using an account.

1. Create a stream

Sign in at hypermass.io, create a stream, and copy its Stream ID from the stream page.

The stream starts as a draft that only you can see. Use Go live on its page when you're ready for others to subscribe.

2. Publish from a folder

hypermass publish <stream id>

With hypermass sync running, place files in <home folder>/hypermass/publications/<stream id>. Each file is published to the stream, then deleted from the folder. Files need to be in the stream's file type, such as JSON or XML.

hypermass status shows each publication's progress.

To keep published files, set disposer-type: move-on-success on the publication in hypermass-config.yaml and run hypermass reload. Published files then move into a complete folder alongside.

Publishing limits

Each stream can publish up to 6 payloads per hour. Think of each stream as having a bucket that holds 6 payloads: every payload you publish adds one to the bucket, and one drains out every 10 minutes. While the bucket has room, you can publish straight away, so a burst of up to 6 goes through at once. Once it's full, the next payload waits until one has drained, about 10 minutes at most.

The CLI handles this for you: when a stream's bucket is full, it waits for the time the service gives and tries again. hypermass status shows when the payload will go.