bucketr

command module
v0.1.0-alpha Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2020 License: BSD-3-Clause Imports: 21 Imported by: 0

README

bucketr

bucketrest is a lightweight RESTful API service that exposes contained key-value databases to the public. As of now, bucketr supports the following databases:

  • MongoDB
  • etcd
  • BoltDB (bbolt)
  • Redis

It's still in early development, so database options are limited. DBs aren't particularly listed in order of priority, but etcd is the most demanded.

Aims

  • Make getting/setting values the exact same API over all DBs to allow client cross-compatibility
  • Make using the API feel like you're using your own DB; endpoints shouldn't include usernames, simply names of contained buckets, completely separate from other users

Installation

Assuming that you've correctly configured Go and have a MongoDB server listening on :27017, run

you@server:~$ go install github.com/fjah/bucketr

then simply execute the binary with

you@server:~$ MONGO_URI=mongodb://localhost:27017 bucketr
db: open
http: ready to listen on :8080

Note that Go and MongoDB need to be installed separately. In the future, this will all be done for you with Docker.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL