> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/documentation/en/framework/externals/projects/redis.md).

# Redis (redis)

Redis project's capability scope, deployment products, integration entrance and usage boundaries.

Integrate Redis cache, sequence number, distributed lock, message flow, configuration and reliable message storage. Each capability shares the same infrastructure, but has different contract and consistency boundaries.

| Item                  | value                                                                                    |
| --------------------- | ---------------------------------------------------------------------------------------- |
| source code directory | `externals/redis`                                                                        |
| main bag              | `Zongsoft.Externals.Redis`                                                               |
| Companion theme       | [Caching and Distributed Coordination](/documentation/en/framework/externals/caching.md) |

## Deployment and Usage Portal

Append the main package to the existing host's [Deployment checklist](/documentation/en/references/deploy-files.md), and retain the plugin list, assembly and ancillary running resources in the package:

{% code title="Application.deploy (append fragment)" %}

```ini
[plugins zongsoft externals redis]
nuget:Zongsoft.Externals.Redis
```

{% endcode %}

The normal connection is located at `/Externals/Redis/ConnectionSettings`, and the driver and provider alias is `Redis`. For example, "Connection name\@Redis" obtains an instance from the Redis provider based on the specified connection name.

## Integration Steps

1. Configure independent test connections per cache topic, using unique keys to verify reads, writes, and cleanups.
2. Verify the actual connection selection, database number and key prefix, and then verify the sequence number or lock according to the required capabilities.
3. When message storage is required, configure the connection and stable storage identity strictly with the same name as the Broker according to the reliability topic.

For specific configuration, calling examples and related basic concepts, see [Caching and Distributed Coordination](/documentation/en/framework/externals/caching.md).

## Project Boundaries

{% hint style="info" %}
💡 Ordinary providers may fallback to default connections, while message storage factories strictly match the Broker name. Shared instances should not release or modify the namespace on request; keyspace notifications are not replayed when disconnected and cannot replace reliable event logs.
{% endhint %}

## Further Reading

[Browse extensions by project](/documentation/en/framework/externals/projects.md) · [Caching and Distributed Coordination](/documentation/en/framework/externals/caching.md) · [source code and project description](https://github.com/Zongsoft/framework/tree/main/externals/redis)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/framework/externals/projects/redis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.