kwaeri-configuration

A Massively Modified Open Source Project by kirvedx

The @kwaeri/configuration component for the @kwaeri/node-kit application platform

TOC

• The Implementation
• Getting Started
  • Installation
  • Usage
• How to Contribute Code
• Other Ways to Contribute
  • Bug Reports
  • Vulnerability Reports
    • Confidential Issues
  • Donations

The Implementation

@kwaeri/configuration provides an implementation for handling configurations, and provides methods for easing the processes of reading, returning, writing and updating configurations for applications and/or application systems.

Getting Started

The following sections cover how to get started with @kwaeri/configuration. For a more formal experience, check the online documentation.

Installation

Start off by installing the module in your project:

npm install --save @kwaeri/configuration

Usage

To leverage the configuration module, you'll first need to include it:

// INCLUDES
import { Configuration } from '@kwaeri/configuration';

Follow up by creating an instance of the configuration object:

const configuration = new Configuration();

The above searches for a JSON configuration, kwaeri.default.json in the current working directory.

const configuration = new Configuration( 'conf', 'plainText.default.conf', true );

The above searches for a plain text configuration, plainText.default.conf in the ./conf directory.

Read Configuration

For a lazy read of the configuration, await a call to get():

const conf = await configuration.get();

If you need to update the configuration from disk, call read() directly:

const conf = await configuration.read();

Write Configuration

To write a new configuration, create the appropriate instance of a Configuration object, and call the write() method:

try {
  // Instantiate a Configuration object
  const configuration = new Configuration( 'conf', 'plainText.default.conf', true );

  // Prepare contents
  const data = `param   value\nparam2  value2`;

  // Write the configuration to disk
  const conf = await configuration.write( data );
}
catch( exception ) {
  // code
}

You can also force a rewrite of the configuration by making a call to write() with no argument.

How to Contribute Code

Our Open Source projects are always open to contribution. If you'd like to cocntribute, all we ask is that you follow the guidelines for contributions, which can be found at the Massively Modified Wiki

There you'll find topics such as the guidelines for contributions; step-by-step walk-throughs for getting set up, Coding Standards, CSS Naming Conventions, and more.

The project also leverages Keybase for communication and alerts - outside of standard email. To join our keybase chat, run the following from terminal (assuming you have keybase installed and running):

keybase team request-access kwaeri

Alternatively, you could search for the team in the GUI application and request access from there.

Other Ways to Contribute

There are other ways to contribute to the project other than with code. Consider testing the software, or in case you've found an Bug - please report it. You can also support the project monetarly through donations via PayPal.

Regardless of how you'd like to contribute, you can also find in-depth information for how to do so at the Massively Modified Wiki

Bug Reports

To submit bug reports, request enhancements, and/or new features - please make use of the issues system baked-in to our source control project space at Gitlab

You may optionally start an issue, track, and manage it via email by sending an email to our project's support desk.

For more in-depth documentation on the process of submitting bug reports, please visit the Massively Modified Wiki on Bug Reports

Vulnerability Reports

Our Vulnerability Reporting process is very similar to Gitlab's. In fact, you could say its a fork.

To submit vulnerability reports, please email our Security Group. We will try to acknowledge receipt of said vulnerability by the next business day, and to also provide regular updates about our progress. If you are curious about the status of your report feel free to email us again. If you wish to encrypt your disclosure email, like with gitlab - please email us to ask for our GPG Key.

Please refrain from requesting compensation for reporting vulnerabilities. We will publicly acknowledge your responsible disclosure, if you request us to do so. We will also try to make the confidential issue public after the vulnerability is announced.

You are not allowed, and will not be able, to search for vulnerabilities on Gitlab.com. As our software is open source, you may download a copy of the source and test against that.

Confidential Issues

When a vulnerability is discovered, we create a [confidential issue] to track it internally. Security patches will be pushed to private branches and eventually merged into a security branch. Security issues that are not vulnerabilites can be seen on our public issue tracker.

For more in-depth information regarding vulnerability reports, confidentiality, and our practices; Please visit the Massively Modified Wiki on Vulnerability

Donations

If you cannot contribute time or energy to neither the code base, documentation, nor community support; please consider making a monetary contribution which is extremely useful for maintaining the Massively Modified network and all the goodies offered free to the public.