caleb-brown/redict
1
0
Fork 0
mirror of https://codeberg.org/redict/redict.git synced 2025-01-21 23:58:51 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Signed-off-by: Drew DeVault <sir@cmpwn.com>
This commit is contained in:
Drew DeVault 2024-03-26 14:11:57 +01:00
parent a8ae9fdb26
commit 04556d4e2c
1 changed files with 42 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -7,17 +7,49 @@ Redict is an independent fork of Redis®\* OSS 7.2.4 licensed under the Lesser
GNU General Public license (LGPL-3.0-only). Redict is not affiliated with
Redis®.
For details on the fork, see the announcement:
## Installation and usage
[Redict is an independent, copyleft fork of Redis®](https://redict.io/posts/2024-03-22-redict-is-an-independent-fork/)
For documentation on Redict's installation and usage, consult [the
website](https://redict.io). The intended audience of this README file are those
who wish to build Redict from source for development purposes.
\* Redis is a registered trademark of Redis Ltd. Any rights therein are reserved
to Redis Ltd. Any use by the Redict project is for referential purposes only and
does not indicate any sponsorship, endorsement or affiliation between Redis and
the Redict project.
## Building Redict from source
## Forking in progress...
Redict only requires a compatible operating system (Unix-like), a standard C11
toolchain, and GNU make. To build Redict, simply run "make".
We're not quite ready to release the first stable version yet. Keep an eye on
the [priority items](https://codeberg.org/redict/redict/issues?q=&type=all&state=open&labels=201153&milestone=0&assignee=0&poster=0)
on the issue tracker for an idea of our progress.
### Customizing the build
You can pass the following variables to Redict to customize the build:
* `USE_JEMALLOC=no MALLOC=libc`: use the libc allocator rather than jemalloc
* `BUILD_TLS=yes`: build with TLS support. Requires OpenSSL.
* `USE_SYSTEMD=yes`: build with systemd support. Requires libsystemd.
* `PROG_SUFFIX="-suffix"`: Append "-suffix" to executable names
### Running tests
To run the test suite, run `./runtest` after the build. The following
additional test suites are provided:
* `./runtest-cluster`: run cluster configuration tests
* `./runtest-moduleapi`: run Redict Module API tests
* `./runtest-sentinel`: run sentinel configuration tests
To run tests with TLS support enabled, build Redict with `BUILD_TLS=yes` and
generate test certificates with `./utils/gen-test-certs.sh`. You may then run
`./runtests --tls` to run the test suite with TLS testing enabled.
## Running Redict
After building Redict, simply run `./src/redict-server`. You may connect to it
with `./src/redict-cli`.
For details on TLS usage, consult TLS.md.
---
<small>* Redis is a registered trademark of Redis Ltd. Any rights therein are
reserved to Redis Ltd. Any use by the Redict project is for referential purposes
only and does not indicate any sponsorship, endorsement or affiliation between
Redis and the Redict project.</small>