Skip to content

Commit 7c4b543

Browse files
committed
updated the Dockerfile & Readme
1 parent 6bbd120 commit 7c4b543

File tree

3 files changed

+24
-11
lines changed

3 files changed

+24
-11
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
bin
22
redix-data
3+
redixdata
34
.DS_STORE

Dockerfile

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
FROM golang:alpine
2+
3+
RUN apk update && apk add git
4+
5+
RUN go get github.com/alash3al/redix
6+
7+
EXPOSE 6380 7090
8+
9+
ENTRYPOINT ["redix"]
10+
11+
WORKDIR /root/

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
Redix
22
=======
3-
> a fast persistent real-time key-value store, that uses the same [RESP](https://redis.io/topics/protocol) protocol and capable to store terabytes of data, also it integrates with your mobile/web apps to add real-time features, soon you can use it as a document store cause it should become a multi-model db. `Redix` is used in production, you can use it in your apps with no worries.
4-
3+
> a fast NoSQL DB, that uses the same [RESP](https://redis.io/topics/protocol) protocol and capable to store terabytes of data, also it integrates with your mobile/web apps to add real-time features, soon you can use it as a document store cause it should become a multi-model db. `Redix` is used in production, you can use it in your apps with no worries.
54
65
Features
76
=========
8-
- Fast on-disk store
7+
- Rich data structure: `KV`, `List`, `Hashmap`
8+
- Advanced Publish/Subscribe using webhook and websocket!
99
- Pluggable Storage Engine (`badger`, `bolt`)
10-
- Multi Core via `-workers=<num workers here>`
11-
- Very easy and simple
12-
- Very compatible with any `redis-client`
13-
- Not only basic redis channels subscriptions, but also there is `webhook` and `websocket`, so you can easily integrate it directly to any web/mobile app.
10+
- Very compatible with any `redis client` including `redis-cli`
11+
- Standalone with no external dependencies
12+
- Helpers commands for `Time`, `Encode <hex|md5|sha1|sha256|sha512> <payload>`, `RANDINT`, `RANDSTR`
13+
-
1414

1515
Why
1616
===
1717
> I started this software to learn more about data modeling, data structures and how to map any data to pure key value, I don't need to build a redis clone, but I need to build something with my own concepts in my own style. I decided to use RESP (redis protocol) so you can use `Redix` with any redis client out there.
1818
19-
Production
20-
==========
21-
> Yep, This software is ready for use in production, and I'm already using it in production as a drop-in-replacement for redis in some softwares in [uFlare](https://uflare.io) for our solutions.
22-
2319
Install
2420
=======
2521
- from source: `go get github.com/alash3al/redix`.
2622
- from binaries: go [there](https://github.com/alash3al/redix/releases) and choose your platform based binary, then download and execute from the command line with `-h` flag to see the help text.
23+
- using docker: `docker run -P -v /path/to/redix-data:/root/redix-data alash3al/redix`
2724

2825
Configurations
2926
============
@@ -170,6 +167,10 @@ TODO
170167
- [x] List Commands
171168
- [x] PubSub Commands
172169
- [x] Utils Commands
170+
- [x] Adding BoltDB engine
171+
- [ ] Adding RAM engine
172+
- [ ] Writing MyOwn DB Engine
173+
- [ ] Writing Test Cases
173174
- [ ] Document/JSON Commands
174175
- [ ] GIS Commands
175176

0 commit comments

Comments
 (0)