Configuration for cobox
Kieran Gibb 9bbc09aa8d
update deps
2 years ago
lib/handlers remove keyPair fn 2 years ago
test remove keyPair fn 2 years ago
.gitignore update with rad gitignore and nyc not istanbul 2 years ago
LICENSE add LICENSE 2 years ago
README.md generate a global identity keypair 2 years ago
example.yaml remove identities from config 2 years ago
index.js update deps 2 years ago
package.json update deps 2 years ago
util.js make isPubKey function more resilent 2 years ago
yarn.lock remove keyPair fn 2 years ago

README.md

cobox-config

Stores and retrieves a YAML configuration file for use with the cobox stack. Also loads up master key to generate a global identity.

Example

const Config = require('cobox-config')
const crypto = require('cobox-crypto')() // or some other crypto scheme

var storage = './storage'
var config = Config(storage)

API

config.save()

Write to YAML storage, path set using the storage path when initialising. Make sure you call this otherwise the config will not write to disk.

config.load()

Load from YAML, path set using the storage path when initialising. This is called automatically when initialising a Config.

var key = group.name || group.address || group.address.toString('hex')
config.groups.get(group)

Get a group from the config

var key = group.name || group.address || group.address.toString('hex')
config.groups.set(group, { name, address, encryptionKey })

Add a group to the config

var key = group.name || group.address || group.address.toString('hex')
config.groups.delete(group)

Remove a group from the config

config.groups.list()

List saved groups

Future Features

  • Store names against ID’s in YAML config file for multiple identity capability