Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gcaufy/freedb
Git based database
https://github.com/gcaufy/freedb
Last synced: about 1 month ago
JSON representation
Git based database
- Host: GitHub
- URL: https://github.com/gcaufy/freedb
- Owner: Gcaufy
- Created: 2019-06-23T15:22:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-14T10:39:45.000Z (over 5 years ago)
- Last Synced: 2024-10-03T07:55:35.119Z (about 2 months ago)
- Language: Go
- Size: 3.68 MB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# freedb
A lightweight solution to use a cloud Key-Value database based on
github.com.
Also available in Node.js [freedb.js](https://github.com/Gcaufy/freedb.js)
## Install
```
go get -u github.com/Gcaufy/freedb
```
## Build from source
See [BUILD.md](BUILD.md).
## Usage
```
$ freedb -?
Usage:
freedb [flags]
Flags:
-b, --branch string Config using branch. (default "master")
-d, --database string Config using database. (default "default")
-e, --execute string Execute command and quit.
-?, --help Display the help
-h, --host string Connect to host, which is a https/ssh git clone link.
-s, --short-output Only output the value
-k, --key string Secret key for encrypt and decrypt.
-t, --token string Access token for the git repository.
```
## How to generate a token
1. Create or use your own github.com account and login.
2. Go to: Settings -> Developer settings -> Personal access tokens -> Generate new token
3. Select scopes: "repo" to make sure you grant access.
## API:
[GoDoc](https://godoc.org/github.com/Gcaufy/freedb/kv)
## How to protect your data
1. Make the repository private.
Simply and easy. Github support private repository
2. Use `-k` option to add a secret key. Then all key and value will be encrypt with AES.