Using An Account
Subscribing to Hypermass works straight away, within a modest allowance that resets each day. An account gives you more: a larger allowance of your own, and the ability to publish your own streams. A free account is enough to start.
Allowances
| Allowance | Resets | |
|---|---|---|
| Without an account | A modest allowance, counted per connection address | Daily, at midnight UTC |
| Free account | A larger allowance of your own, wherever you connect from | Monthly |
| Paid plans | Larger again - see the plans once signed in at hypermass.io/upgrade-plan | Monthly |
An allowance of your own matters most where many people share one connection: everyone in an office, a university or a council network counts as one address until they sign in.
When an allowance runs out, hypermass sync waits, then carries on by itself once it resets. It says when that will
be, and hypermass status shows the same against each stream that is waiting.
Add your key
- Create a free account at hypermass.io, and an access key at hypermass.io/access-keys.
- Run
hypermass loginand paste the key in. - Restart
hypermass sync, which reads the key when it starts.
hypermass info shows whether a key is saved.
Where the key is kept
In auth.yaml, in the CLI's configuration folder - hypermass info shows where. The file is readable by you alone.
Keep it out of backups and version control: a new key is quick to create.
Changing or removing your key
- To replace it: run
hypermass loginagain, then restarthypermass sync. - To go back to the free daily allowance: delete
auth.yaml, then restarthypermass sync.
If a key is revoked, hypermass status shows a warning. Create a new key and run hypermass login.