Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

confignexus

0.4.1 • Public • Published

Nexus Config Server

API server for distributing deployment configuration across servers

The basic idea:

  • Apps being deployed (eg. Docker containers) do not have configuration files in them. They only have a token and a API url.
  • Apps contact the server API and provide their key
  • The server validates the key and checks for access grants
  • The server responds with a list of configuration files in JSON that the application has been given access to

This current version:

  • Uses SQLite and MySQL
  • Is not recommended for production

This is a work in progress

Clients

Requirements

  • Node.js v0.10
  • Grunt (npm install -g grunt-cli)
  • Bower (npm install -g bower)

or

  • Docker

Environment Variables

Database configuration:

  • DB_NAME: Database name
  • DB_USERNAME: Database username
  • DB_PASSWORD: Database password
  • DB_HOST: Database host
  • DB_DIALECT: Database dialect (mysql or sqlite)

Server configuration:

  • PORT: Port the server should listen on (make sure to expose the right port), defaults to 5000
  • SESSION_SECRET: Random stirng to use as a session secret

Setup configuration:

  • MIGRATE: Run migrations on startup
  • SETUP: Create initial root user

Setup from Docker

1.- Export any configuration environment variables mentioned above

2.- Run the image using Docker: docker run -e "MIGRATE=true" -e "SETUP=true" -p 5000:5000 eduard44/nexus

3.- CTRL+C to interrupt the server

4.- Relaunch without migrations: docker run -p 5000:5000 eduard44/nexus

Now, you can head to http://localhost:5000 and login with user root and password root

Setup from source

First, check the configuration file in /config After the application is configured, you can run the following commands to get the server running:

1.- Clone the git repository: git clone git@github.com:eduard44/nexus.git

2.- cd nexus

3.- Install Node.js dependencies: npm install

4.- Install Bower dependencies: bower install or bower update

5.- Build JS and SCSS files: grunt build

6.- Run the server: node app --rebuild or node app if the database is already created

Now, you can head to http://localhost:5000 and login with user root and password root

Keywords

none

install

npm i confignexus

Downloadsweekly downloads

1

version

0.4.1

license

GPL v2

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar