RedisUI.Dashboard 2.0.0

RedisUI.Dashboard

A modern Redis UI for ASP.NET Core with enhanced features, built as a fork of RedisUI.

🔥 What’s New in RedisUI.Dashboard

This fork includes major improvements over the original RedisUI:

• ✅ Support for Redis data types: Stream, Sorted Set, Hash, List, Set, String.
• ✅ Error prevention: Null-safe resolution to prevent NullReferenceException.
• ✅ Monokai-highlighted JSON: Key values rendered as readable formatted JSON.
• ✅ UI and performance upgrades:
  • Redesigned layout and styles
  • SCAN cursor enhancements
  • Async parallel Redis key & stat resolution
• ✅ Middleware refactor: Clearer API with overloads instead of optional params.
• ✅ .NET 9 support: Added to TargetFrameworks.

🚀 Installation

Install via NuGet:

dotnet add package RedisUI.Dashboard

## 🔧 Recent Enhancements by @frankyjquintero

This project has undergone several significant improvements to enhance functionality, robustness, and forward compatibility. Notable changes include:

- ✅ **Support for additional Redis data types**: Stream, Sorted Set, Hash, and more are now properly rendered.
- ✅ **Error prevention enhancements**: Null checks were added to avoid potential `NullReferenceException` issues.
- ✅ **Cleaner JSON handling**: Implemented JSON mapping and Monokai syntax highlighting for Redis key inspection.
- ✅ **Improved UI stability**: Refactored HTML rendering, redesigned UI, and cleaned up JS, including cursor-based SCAN enhancements.
- ✅ **Optimized performance**: Parallel async resolution for Redis statistics and key values; optimized ConnectionMultiplexer singleton.
- ✅ **Simplified middleware API**: Refactored `RedisUIMiddleware`, `RedisKeyValueResolver`, and POST body handling; fixed overloading mechanism.
- ✅ **Extended .NET support**: Added compatibility for .NET 9 and updated TargetFrameworks accordingly.

## 🔧 Custom JS and CSS for RedisUI Viewer

You can customize the appearance and behavior of the Redis UI by providing your own JavaScript and CSS files. This is useful if you want to use local versions of Bootstrap, syntax highlighters, or JSON viewers.

### Example

```csharp
app.UseRedisUI(new RedisUISettings
{
    CssLink = "/assets/css/bootstrap.min.css",
    JsLink = "/assets/js/bootstrap.bundle.min.js",
    HighlightTheme = "/assets/css/highlight-dark.css",
    HighlightJs = "/assets/js/highlight.min.js",
    HighlightJson = "/assets/js/json-viewer.js"
});

UI

Server Statistics

👉 You can review the updated source and commits at github.com/frankyjquintero/RedisUI

Redis Integrated UI

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.

Features

• 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.

• Server Statistics: Displays statistics related to the Redis server for monitoring and analysis purposes.

Getting Started

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!

Settings

• 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",
});

• Use ConfigurationOptions for detailed settings.

ConfigurationOptions options = new ConfigurationOptions
{
    EndPoints = { { "my-redis.cloud.redislabs.com", 6379 } },
    User = "default",  // use your Redis user. More info https://redis.io/docs/management/security/acl/
    Password = "secret", // use your Redis password
    Ssl = true,
    SslProtocols = System.Security.Authentication.SslProtocols.Tls12                
};

app.UseRedisUI(new RedisUISettings
{
    ConfigurationOptions = options
});

• 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"
});

Authorization

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())
});

Contributing

Contributions are welcome! If you'd like to contribute to Redis Integrated UI, please follow these guidelines:

1. Fork the repository.
2. Create your feature branch (git checkout -b feature/YourFeature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Create a new Pull Request.

License

This project is licensed under the MIT License.

Contact

For any inquiries or support regarding Redis Integrated UI, feel free to contact the project maintainer:

• Email: emrahkondur@hotmail.com
• GitHub: ekondur