Skip to content

Commit 4ae6cbe

Browse files
nermillerchayimK-Jo
authored
Get started update (#120)
* Updates get started * Updates dictionary and adds CLI redisinsight to mac install * Updates dictionary * Update docs/stack/about/index.md * Incorporates feedback * Updates dictionary * Update docs/stack/about/index.md * Updates the index page * Updates the index page * Update index.md * small changes * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Nermina Miller <102551568+nermiller@users.noreply.github.com> * Update docs/stack/about/index.md Co-authored-by: Chayim <chayim@users.noreply.github.com> Co-authored-by: Pieter Cailliau <pieter@redis.com>
1 parent 8e86363 commit 4ae6cbe

File tree

8 files changed

+171
-135
lines changed

8 files changed

+171
-135
lines changed

‎dictionary.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@ Analytics
66
analytics
77
anonymized
88
APIs
9+
AppImage
910
atomicity
1011
CLI
1112
CLI-based
1213
Caskroom
1314
CentOS7
1415
Centos8
16+
chmod
1517
CO2
1618
CommandLineRunner
1719
Config
@@ -101,10 +103,12 @@ Pydantic
101103
queryable
102104
Queryable
103105
README
106+
read-eval-print-loop
104107
REDISTIMESERIES_ARGS
105108
REDIS_ARGS
106109
RedisAI
107110
RedisGears
111+
redisinsight
108112
REDiss
109113
RHEL7
110114
RHEL8

‎docs/stack/_index.md

Lines changed: 1 addition & 129 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +1,6 @@
11
---
22
title: Redis Stack
33
linkTitle: Redis Stack
4-
description: Extends Redis with modern data models and processing engines. Includes documentation for the bundled Redis modules and RedisInsight.
4+
description: Extends Redis with modern data models and processing engines
55
---
66

7-
Redis Stack is the best starting point for working with Redis. We've bundled together the best of the technology that we have to offer into an easy to use package. Redis Stack extends the core capabilities of Redis OSS and provides a complete developer experience for debugging and more.
8-
9-
In addition to all of the features of Redis OSS, Redis Stack supports:
10-
11-
* Probabilistic data structures
12-
* Queryable JSON documents
13-
* Querying across hashes and JSON documents, including full-text search
14-
* Time series data support (ingestion & querying)
15-
* Graph data models with the Cypher query language
16-
17-
## Why Redis Stack?
18-
19-
Redis Stack was created to allow developers to build real-time applications with a backend data platform that can reliably process requests in
20-
milliseconds or less. Redis Stack does this by taking the original Redis OSS as the core and enhancing it with modern data models, data processing tools,
21-
and continuing to fight complexity at every turn. Ultimately, the goal of Redis Stack is to build a real-time data platform that continues to fulfill the
22-
philosophy of Redis OSS: simplicity, performance, and reliability.
23-
24-
Redis Stack unifies and simplifies the developer experience of the leading Redis modules and the capabilities they provide. Redis Stack bundles
25-
five Redis modules: [RedisJSON](/docs/stack/json), [RediSearch](/docs/stack/search), [RedisGraph](/docs/stack/graph),
26-
[RedisTimeSeries](/docs/stack/timeseries), and [RedisBloom](/docs/stack/bloom).
27-
28-
The overarching vision is to provide developers with a powerful platform for all real-time data use cases. As we continue to advance the capabilities of
29-
Redis beyond caching, Redis Stack is the place to start. Redis Stack delivers the core capabilities developers love about Redis and goes beyond
30-
to help you build modern applications where performance is paramount.
31-
32-
## Redis Stack packaging
33-
34-
There are three distinct Redis Stack packages to choose from:
35-
36-
* **Redis Stack Server**: This package contains Redis OSS and module extensions only. It does *not* contain RedisInsight, the developer desktop
37-
application. This package is best for production deployment and is intended to be a drop-in replacement (for example, if you're already deploying
38-
Redis OSS as a cache).
39-
40-
* **Redis Stack (Desktop)**: This package contains everything a developer needs in a single bundle. This includes Redis OSS and module extensions
41-
along with the RedisInsight desktop application. If you want to create an application locally and explore how it interacts with Redis, this is
42-
the package for you.
43-
44-
* **RedisInsight**: This package ONLY contains RedisInsight, the developer desktop application. If you've used Redis Stack Server and
45-
you also want to use RedisInsight to explore your Redis data, select this package.
46-
47-
## Getting started
48-
49-
To get started with Redis Stack, see the [Getting Started](/docs/stack/get-started/) guide. You may also want to:
50-
51-
* [Install Redis Stack](/docs/stack/get-started/install/)
52-
* [See the list of clients supporting Redis Stack](/docs/stack/get-started/clients/)
53-
* [View the Redis Stack tutorials](/docs/stack/get-started/tutorials/)
54-
55-
## Use cases
56-
57-
Explore [use cases](/docs/stack/use-cases/) of the applied modern data models and processing engines provided by Redis Stack across industries and applications.
58-
59-
{{% alert title="Note" color="warning" %}}
60-
61-
Modules as described here are generic, and we list only the representative use cases.
62-
63-
{{% /alert %}}
64-
65-
## Clients
66-
67-
Several Redis client libraries support Redis Stack. These include [redis-py](https://redis-py.readthedocs.io/en/stable/), [node_redis](https://github.com/redis/node-redis), and [Jedis](https://github.com/redis/jedis). In addition, four higher-level object
68-
mapping libraries also support Redis Stack: [Redis OM .NET](/docs/stack/get-started/tutorials/stack-dotnet/), [Redis OM Node](/docs/stack/get-started/tutorials/stack-node/), [Redis OM Python](/docs/stack/get-started/tutorials/stack-python/), [Redis OM Spring](/docs/stack/get-started/tutorials/stack-spring/).
69-
70-
## RedisInsight
71-
72-
Redis Stack also includes [RedisInsight](https://docs.redis.com/latest/ri/), a visualization tool for understanding and optimizing Redis data.
73-
74-
RedisInsight allows you to:
75-
* View performance metrics for your Redis instance with the Overview tool
76-
* View data structures visually with the Browser tool
77-
* Manage basic properties of your Redis cluster such as cluster node timeout, IP, or port with the Cluster Management tool
78-
* Run commands with a REPL (read-eval-print-loop) the CLI tool
79-
* Analyze memory usage with the Memory Analysis tool
80-
* Identify and troubleshoot bottlenecks with the Slowlog tool
81-
* Edit the configuration of your Redis instance with the Configuration tool
82-
* and more...
83-
84-
## Redis Stack license
85-
86-
Redis Stack is made up of several components, licensed as follows:
87-
88-
* Redis Stack Server, which combines open source Redis with RediSearch, RedisJSON, RedisGraph, RedisTimeSeries, and RedisBloom, is dual-licensed under the Redis Source Available License ([RSALv2]((/docs/stack/license/)) and the [Server Side Public License](https://en.wikipedia.org/wiki/Server_Side_Public_License) (SSPL). A breakdown of licensing by Stack component versions is shown in the table below. For more information about Redis licensing, see [Licenses](https://redis.com/legal/licenses/).
89-
90-
* RedisInsight is licensed under the SSPL.
91-
92-
### Versions and licenses
93-
94-
Starting November 15, 2022, our default binary distributions of Redis Stack and our Redis modules have been dual-licensed under RSALv2 and SSPL. When using the source code, you can apply either RSALv2 or SSPLv1.
95-
96-
<table>
97-
<tr>
98-
<th>Module</th>
99-
<th>RSALv1</th>
100-
<th>Binary distribution: RSALv2</br>
101-
Source code: RSALv2 or SSPLv1</th>
102-
</tr>
103-
<tr>
104-
<td>Redis Stack</td>
105-
<td><= 6.2.4</td>
106-
<td>>= 6.2.6</td>
107-
</tr>
108-
<tr>
109-
<td>RediSearch</td>
110-
<td><= 2.4</td>
111-
<td>>= 2.6</td>
112-
</tr>
113-
<tr>
114-
<td>RedisJSON</td>
115-
<td><= 2.2</td>
116-
<td>>= 2.4</td>
117-
</tr>
118-
<tr>
119-
<td>RedisGraph</td>
120-
<td><=2.8</td>
121-
<td>>=2.10</td>
122-
</tr>
123-
<tr>
124-
<td>RedisTimeSeries</td>
125-
<td><=1.6</td>
126-
<td>>= 1.8</td>
127-
</tr>
128-
<tr>
129-
<td>RedisBloom</td>
130-
<td><= 2.2</td>
131-
<td>>=2.4</td>
132-
</tr>
133-
</table>
134-

‎docs/stack/about/index.md

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
---
2+
title: About Redis Stack
3+
linkTitle: About
4+
description: Learn more about Redis Stack
5+
weight: 1
6+
---
7+
8+
Redis Stack is the best starting point for working with Redis. We've bundled together the best of the technology that we have to offer into an easy-to-use package. Redis Stack extends the core capabilities of Redis OSS and provides a complete developer experience for debugging and more.
9+
10+
In addition to all of the features of Redis OSS, Redis Stack supports:
11+
12+
* Probabilistic data structures
13+
* Queryable JSON documents
14+
* Querying across hashes and JSON documents
15+
* Time series data support (ingestion & querying), including full-text search
16+
* Graph data models with the Cypher query language
17+
18+
## Why Redis Stack?
19+
20+
Redis Stack was created to allow developers to build real-time applications with a backend data platform that can reliably process requests in
21+
milliseconds or less. Redis Stack does this by taking the original Redis OSS as the core and enhancing it with modern data models, data processing tools,
22+
and continuing to fight complexity at every turn. Ultimately, the goal of Redis Stack is to build a real-time data platform that continues to fulfill the
23+
philosophy of Redis OSS: simplicity, performance, and reliability.
24+
25+
Redis Stack unifies and simplifies the developer experience of Redis by offering all the cutting-edge capabilities provided by the leading Redis modules. Redis Stack bundles the following capabilities into Redis: [RedisJSON](/docs/stack/json), [RediSearch](/docs/stack/search), [RedisGraph](/docs/stack/graph),
26+
[RedisTimeSeries](/docs/stack/timeseries), and [RedisBloom](/docs/stack/bloom).
27+
28+
The overarching vision is to provide developers with a powerful platform for all real-time data use cases. As we continue to advance the capabilities of
29+
Redis beyond caching, Redis Stack is the place to start. Redis Stack delivers the core capabilities developers love about Redis and goes beyond
30+
to help you build modern applications where performance is paramount.
31+
32+
## RedisInsight
33+
34+
The best way to get started with Redis Stack is with [RedisInsight](https://docs.redis.com/latest/ri/), a visualization tool for understanding and optimizing Redis data.
35+
36+
RedisInsight allows you to:
37+
* View data structures visually with the Browser tool and group keys according to their namespaces.
38+
* Use CRUD on most Redis Stack data structures.
39+
* Leverage Workbench, an advanced command-line interface with intelligent command auto-complete and complex data visualizations.
40+
* Analyze traffic to Redis in real time using the Profiler tool.
41+
* Use embedded Redis CLI at any time.
42+
* Analyze memory usage with the Memory Analysis tool.
43+
* Identify and troubleshoot bottlenecks using the Slowlog tool.
44+
45+
## Redis Stack packaging
46+
47+
There are two distinct Redis Stack packages to choose from:
48+
49+
* **Redis Stack Server**: This package contains Redis OSS and module extensions only. It does *not* contain RedisInsight, the developer desktop
50+
application. This package is best for production deployment and is intended to be a drop-in replacement (for example, if you're already deploying
51+
Redis OSS as a cache). You can still download RedisInsight separately.
52+
53+
* **Redis Stack**: This package contains everything a developer needs in a single bundle. This includes Redis Stack Server (Redis OSS and module extensions)
54+
along with the RedisInsight desktop application (or part of the docker container). If you want to create an application locally and explore how it interacts with Redis, this is
55+
the package for you.
56+
57+
## Use cases
58+
59+
Explore [use cases](/docs/stack/use-cases/) of the applied modern data models and processing engines provided by Redis Stack across industries and applications.
60+
61+
{{% alert title="Note" color="warning" %}}
62+
63+
Modules as described here are generic, and we list only the representative use cases.
64+
65+
{{% /alert %}}
66+
67+
## Clients
68+
69+
Several Redis client libraries support Redis Stack. These include [redis-py](https://redis-py.readthedocs.io/en/stable/), [node_redis](https://github.com/redis/node-redis), [NRedisStack](https://github.com/redis/NRedisStack), and [Jedis](https://github.com/redis/jedis). In addition, four higher-level object
70+
mapping libraries also support Redis Stack: [Redis OM .NET](/docs/stack/get-started/tutorials/stack-dotnet/), [Redis OM Node](/docs/stack/get-started/tutorials/stack-node/), [Redis OM Python](/docs/stack/get-started/tutorials/stack-python/), [Redis OM Spring](/docs/stack/get-started/tutorials/stack-spring/).
71+
72+
## Redis Stack license
73+
74+
Redis Stack is made up of several components, licensed as follows:
75+
76+
* Redis Stack Server, which combines open source Redis with RediSearch, RedisJSON, RedisGraph, RedisTimeSeries, and RedisBloom, is dual-licensed under the Redis Source Available License ([RSALv2]((/docs/stack/license/)) and the [Server Side Public License](https://en.wikipedia.org/wiki/Server_Side_Public_License) (SSPL). A breakdown of licensing by Stack component versions is shown in the table below. For more information about Redis licensing, see [Licenses](https://redis.com/legal/licenses/).
77+
78+
* RedisInsight is licensed under the SSPL.
79+
80+
### Versions and licenses
81+
82+
Since November 15, 2022, our default binary distributions of Redis Stack and our Redis modules are dual-licensed under RSALv2 and SSPL. When using the source code, you can apply either RSALv2 or SSPLv1.
83+
84+
<table>
85+
<tr>
86+
<th>Module</th>
87+
<th>RSALv1</th>
88+
<th>Binary distribution: RSALv2</br>
89+
Source code: RSALv2 or SSPLv1</th>
90+
</tr>
91+
<tr>
92+
<td>Redis Stack</td>
93+
<td><= 6.2.4</td>
94+
<td>>= 6.2.6</td>
95+
</tr>
96+
<tr>
97+
<td>RediSearch</td>
98+
<td><= 2.4</td>
99+
<td>>= 2.6</td>
100+
</tr>
101+
<tr>
102+
<td>RedisJSON</td>
103+
<td><= 2.2</td>
104+
<td>>= 2.4</td>
105+
</tr>
106+
<tr>
107+
<td>RedisGraph</td>
108+
<td><=2.8</td>
109+
<td>>=2.10</td>
110+
</tr>
111+
<tr>
112+
<td>RedisTimeSeries</td>
113+
<td><=1.6</td>
114+
<td>>= 1.8</td>
115+
</tr>
116+
<tr>
117+
<td>RedisBloom</td>
118+
<td><= 2.2</td>
119+
<td>>=2.4</td>
120+
</tr>
121+
</table>
122+
123+
To get going quickly with Redis Stack, see the [Get started](/docs/stack/get-started/) guide.

‎docs/stack/get-started/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
title: Get started with Redis Stack
33
linkTitle: Get started
44
description: How to install and get started with Redis Stack
5-
weight: 1
5+
weight: 2
66
---
7+

‎docs/stack/get-started/install/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
title: Install Redis Stack
33
linkTitle: Install
44
description: "How to install Redis Stack"
5-
weight: 1
5+
weight: 2
66
---

‎docs/stack/get-started/install/docker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:lat
3232
The `docker run` command above also exposes RedisInsight on port 8001. You can use RedisInsight by pointing your browser to `localhost:8001`.
3333

3434
## Connect with redis-cli
35+
3536
You can then connect to the server using `redis-cli`, just as you connect to any Redis instance.
3637

3738
If you don’t have `redis-cli` installed locally, you can run it from the Docker container:

‎docs/stack/get-started/install/linux.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
title: Install Redis Stack on Linux
33
linkTitle: Linux
44
description: "How to install Redis Stack on Linux"
5-
weight: 1
5+
weight: 2
66
---
77

8+
Learn how to install Redis Stack on Linux from the official repository, RPM feed, with snap, or AppImage.
89

9-
10-
### From the official Debian/Ubuntu APT Repository
10+
## From the official Debian/Ubuntu APT Repository
1111
You can install recent stable versions of Redis Stack from the official packages.redis.io APT repository. The repository currently supports Debian Bullseye (11), Ubuntu Xenial (16.04), Ubuntu Bionic (18.04), and Ubuntu Focal (20.04) on x86 processors. Add the repository to the apt index, update it, and install it:
1212

1313
{{< highlight bash >}}
@@ -17,7 +17,7 @@ sudo apt-get update
1717
sudo apt-get install redis-stack-server
1818
{{< / highlight >}}
1919

20-
### From the official RPM Feed
20+
## From the official RPM Feed
2121

2222
You can install recent stable versions of Redis Stack from the official packages.redis.io YUM repository. The repository currently supports RHEL7/CentOS7, and RHEL8/Centos8. Add the repository to the repository index, and install the package.
2323

@@ -37,3 +37,29 @@ sudo rpm --import /tmp/redis.key
3737
sudo yum install epel-release
3838
sudo yum install redis-stack-server
3939
{{< / highlight >}}
40+
41+
## With snap
42+
43+
From [Download](/download/), get the latest Stack snap package.
44+
45+
To install, run:
46+
47+
{{< highlight text >}}
48+
sudo snap install --dangerous --classic <snapname.snap>
49+
{{< / highlight >}}
50+
51+
## With AppImage
52+
53+
From [Download](/download/), get the latest Stack AppImage package.
54+
55+
Enable the install:
56+
57+
{{< highlight text >}}
58+
chmod a+x <AppImagefile>
59+
{{< / highlight >}}
60+
61+
To install, run
62+
63+
{{< highlight text >}}
64+
./<appimagefile>
65+
{{< / highlight >}}

‎docs/stack/get-started/install/mac-os.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,15 @@ You can now start Redis Stack Server as follows:
7373
redis-stack-server
7474
{{< / highlight >}}
7575

76+
## Launch RedisInsight
77+
78+
To start up the Redis UI, RedisInsight, type:
79+
80+
{{< highlight bash >}}
81+
redisinsight
82+
{{< / highlight >}}
83+
84+
7685
## Installing Redis after installing Redis Stack
7786

7887
If you've already installed Redis Stack with Homebrew and then try to install Redis with `brew install redis`, you may encounter errors like the following:

0 commit comments

Comments
 (0)