Scalable, simple RESTful object storage platform, written in C#
Scalable, simple RESTful object storage platform, written in C#
First things first - do you need help or have feedback? File an issue here!
The binaries for Kvpbase can be created by compiling from source or using the pre-compiled binaries found in Kvpbase.StorageServer\bin\release\net5.0\
(I intentionally did not .gitignore
these files). Executing the binaries will create the requisite configuration files and database tables.
$ dotnet Kvpbase.StorageServer.dll
By default, Kvpbase will listen on localhost
and only handle requests from the local machine. If you wish to change this, modify Server.DnsHostname
in the system.json
file. When modifying this value, follow these rules:
0.0.0.0
, *
, or +
, Kvpbase must be run using elevated privilegesBy default, data is stored within ./Storage/[userguid]/[containername]
. The setup process will create a series of sample files within the default
user's container, also named default
, which is configured for public/unauthenticated read access:
To create your first object, call POST /[userguid]/[containername]/[objectkey]
. A simple cURL example is shown here.
$ curl -X POST -d "My first object!" "http://localhost:8000/default/default/firstfile.txt?x-api-key=default"
The response is simply a 200/OK.
Then retrieve it:
$ curl http://localhost:8000/default/default/firstfile.txt
The result is a 200/OK with your data:
My first object!
To see the contents of your container, call GET /[userguid]/[containername]
.
$ curl "http://localhost:8000/default/default"
To delete your first object, call DELETE /[userguid]/[containername]/[objectkey]
. A simple cURL example is shown here.
$ curl -X DELETE "http://localhost:8000/default/default/firstfile.txt?x-api-key=default"
The response is simply a 200/OK.
Please visit our documentation [https://github.com/jchristn/Kvpbase/wiki] for details on APIs, configuration files, deployment scenarios, and more.
Core use cases for Kvpbase Storage Server:
Refer to CHANGELOG.md for version history.