-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,43 @@ | ||
# Bedel | ||
|
||
[![Go Report Card](https://goreportcard.com/badge/github.com/ncode/bedel)](https://goreportcard.com/report/github.com/ncode/bedel) | ||
[![codecov](https://codecov.io/gh/ncode/bedel/graph/badge.svg?token=N98KAO33K5)](https://codecov.io/gh/ncode/bedel) | ||
|
||
... | ||
`bedel` is a tool designed to address a specific challenge with Redis: synchronizing users generated externally, such as through the Vault database backend, with the Redis configuration. This utility ensures that Redis user configurations are up-to-date and consistent with external user generation sources. More info [here](https://github.com/redis/redis/issues/7988). | ||
|
||
## Features | ||
|
||
- Synchronize Redis users created outside the traditional config file. | ||
- Integration with Vault database backend for user management. | ||
- Automated and consistent user synchronization. | ||
- Easy to deploy and integrate within existing Redis setups. | ||
|
||
## Getting Started | ||
|
||
These instructions will guide you through getting a copy of `bedel` up and running on your system for development and testing purposes. | ||
|
||
### Prerequisites | ||
|
||
- Redis server setup. | ||
- Access to Vault database backend (if using Vault for user generation). | ||
- Go environment for development. | ||
|
||
### Installing | ||
|
||
Follow these steps to get a development environment running: | ||
|
||
## Why? | ||
1. Clone the repository: | ||
```bash | ||
$ git clone https://github.com/ncode/bedel.git | ||
$ cd bedel | ||
$ go build | ||
``` | ||
|
||
... | ||
### Running the Tests | ||
|
||
## How to use it? | ||
To run the automated tests for this system, use the following command: | ||
|
||
... | ||
```bash | ||
$ go test ./... | ||
``` | ||
|