/lsmsd

lightweight storage management system daemon

Primary LanguageGoGNU Affero General Public License v3.0AGPL-3.0

lsmsd - lightweight storage management system daemon Build Status

lsmsd is a storage management system designed for our local hackerspace.


Installation

lsmsd requires Go 1.4 or greater. Thanks to the Go toolset the installation is very easy. Just type the following in your terminal and press Enter:

go get github.com/openlab-aux/lsmsd

This software needs a running instance of mongoDB. For install instructions click here

Building a test instance with Vagrant

Spin up the box with vagrant up. vagrant ssh into the box and start lsmsd:

cd /vagrant
cp example_config.gcfg config.gcfg
./lsmsd

Leave the terminal open. Now you should be able to access the lsmsd api on your host machine on port 8080

http loalhost:8080/items

Roadmap for 0.1

  • Notifications via E-Mail / XMPP
  • Logging and error message overhaul
  • Better test coverage & code documentation
  • Websockets
  • Manual
  • Item images (GridFS)

Documentation

Code Documentation for this tool can be found at godoc.

REST-Api Documentation

This project uses swagger to document its API. Just run lsmsd and open http[s]://[whereitlistens]:[PORT]/apidocs/ and type http[s]://[whereitlistens]:[PORT]/apidocs.json into the textfield at the top of the page.