Skip to main content

Subscribe And Publish

hypermass subscribe and hypermass publish add a stream to your configuration with sensible defaults, so the only thing you need is the stream's ID - shown on its page at hypermass.io. Both write an ordinary entry into hypermass-config.yaml, which you can change later - see Managing your configuration.

Subscribe​

hypermass subscribe _254gGE43g

This checks that you can subscribe to the stream, then adds it to hypermass-config.yaml:

  • Files arrive in <home folder>/hypermass/subscriptions/<stream id>, one file per payload.
  • If hypermass sync is running, the subscription starts straight away. Otherwise it starts with the next hypermass sync.
  • Subscribing to a stream you already follow changes nothing.

Publish​

Publishing needs an account - see Using an account.

hypermass publish <your stream id>

This checks that the stream is yours, then adds it to hypermass-config.yaml:

  • With hypermass sync running, files you place in <home folder>/hypermass/publications/<stream id> are 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.

Unsubscribe​

Subscriptions and publications are entries in hypermass-config.yaml - hypermass info shows where the file is. To stop one:

  1. Delete its entry from subscription-targets or publication-sources.
  2. Run hypermass reload, which stops the stream and lists it as removed.

hypermass status shows what's running as you go, so you can check the stream has gone.

The stream's folder stays in place, along with any files still in it - clear out old subscription and publication folders yourself once you're done with them.

warning

Subscribing to the same stream again with the folder still there, will carry on from where it left off - even if weeks or months pass. If you don't intend for this to happen delete the folder. It may impact your allowance of data transfer.

To change a stream's folder or other settings instead, see Managing your configuration.