Redis Integrated UI is a .NET project designed to simplify the integration of a Redis User Interface (UI) page into your web applications. With this project, users can easily incorporate a Redis UI page, enabling them to interact with Redis keys and view Redis server statistics seamlessly.
-
Integration Ease: Simplifies the process of integrating a Redis UI page into web applications.
-
Redis Key Management: Provides functionality to interact with Redis keys conveniently. (Read-only for now)
-
Server Statistics: Displays statistics related to the Redis server for monitoring and analysis purposes.
To integrate the Redis UI into your application, follow these steps:
- Install RedisUI from the NuGet Gallery.
PM> Install-Package RedisUI
- Add the middleware to your project.
using RedisUI;
app.UseRedisUI();
- Run your project and browse /redis path. easy peasy!
- The
Path
is "/redis" by default, set a new path.
app.UseRedisUI(new RedisUISettings
{
Path = "/myredisui",
});
- The
ConnectionString
is "localhost" by default, set the connection string.
app.UseRedisUI(new RedisUISettings
{
ConnectionString = "1.1.1.1:6379",
});
- The UI is using Bootstrap 5.3.2 version from CDN, you can get it from locally via setting properties below:
app.UseRedisUI(new RedisUISettings
{
CssLink = "..\\mypath\\bootstrap.min.cs",
JsLink = "..\\mypath\\bootstrap.js"
});
You can limit access to Redis data in the production environment.
- Add a new authorization filter and implement
IRedisAuthorizationFilter
using RedisUI;
public class MyAuthorizationFilter : IRedisAuthorizationFilter
{
private readonly bool _isDevelopment;
public MyAuthorizationFilter(bool isDevelopment)
{
_isDevelopment = isDevelopment;
}
public bool Authorize(HttpContext context)
{
return _isDevelopment || (context.User.Identity != null && context.User.Identity.IsAuthenticated);
}
}
app.UseRedisUI(new RedisUISettings
{
AuthorizationFilter = new MyAuthorizationFilter(app.Environment.IsDevelopment())
});
Contributions are welcome! If you'd like to contribute to Redis Integrated UI, please follow these guidelines:
- Fork the repository.
- Create your feature branch (
git checkout -b feature/YourFeature
). - Commit your changes (
git commit -am 'Add some feature'
). - Push to the branch (
git push origin feature/YourFeature
). - Create a new Pull Request.
This project is licensed under the MIT License.
For any inquiries or support regarding Redis Integrated UI, feel free to contact the project maintainer:
- Email: [email protected]
- GitHub: ekondur