Unverified Commit 94b9072e authored by Lior Kogan's avatar Lior Kogan Committed by GitHub
Browse files

Rename to "Redis Community Edition" (#13448)

parent e74550dd
This README is just a fast *quick start* document. You can find more detailed documentation at [redis.io](https://redis.io). This README is just a fast *quick start* document. You can find more detailed documentation at [redis.io](https://redis.io).
What is Redis? What is Redis?
-------------- ---
Redis is often referred to as a *data structures* server. What this means is that Redis provides access to mutable data structures via a set of commands, which are sent using a *server-client* model with TCP sockets and a simple protocol. So different processes can query and modify the same data structures in a shared way. Redis is often referred to as a *data structures* server. What this means is that Redis provides access to mutable data structures via a set of commands, which are sent using a *server-client* model with TCP sockets and a simple protocol. So different processes can query and modify the same data structures in a shared way.
...@@ -20,8 +20,18 @@ If you want to know more, this is a list of selected starting points: ...@@ -20,8 +20,18 @@ If you want to know more, this is a list of selected starting points:
* The full list of Redis commands. https://redis.io/commands * The full list of Redis commands. https://redis.io/commands
* There is much more inside the official Redis documentation. https://redis.io/documentation * There is much more inside the official Redis documentation. https://redis.io/documentation
What is Redis Community Edition?
---
Redis OSS was renamed Redis Community Edition (CE) with the v7.4 release.
Redis Ltd. also offers [Redis Software](https://redis.io/enterprise/), a self-managed software with additional compliance, reliability, and resiliency for enterprise scaling,
and [Redis Cloud](https://redis.io/cloud/), a fully managed service integrated with Google Cloud, Azure, and AWS for production-ready apps.
Read more about the differences between Redis Community Edition and Redis [here](https://redis.io/comparisons/oss-vs-enterprise/).
Building Redis Building Redis
-------------- ---
Redis can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD. Redis can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD.
We support big endian and little endian architectures, and both 32 bit We support big endian and little endian architectures, and both 32 bit
...@@ -65,7 +75,7 @@ installed): ...@@ -65,7 +75,7 @@ installed):
Fixing build problems with dependencies or cached build options Fixing build problems with dependencies or cached build options
--------- ---
Redis has some dependencies which are included in the `deps` directory. Redis has some dependencies which are included in the `deps` directory.
`make` does not automatically rebuild dependencies even if something in `make` does not automatically rebuild dependencies even if something in
...@@ -85,7 +95,7 @@ those options are cached indefinitely until you issue a `make distclean` ...@@ -85,7 +95,7 @@ those options are cached indefinitely until you issue a `make distclean`
command. command.
Fixing problems building 32 bit binaries Fixing problems building 32 bit binaries
--------- ---
If after building Redis with a 32 bit target you need to rebuild it If after building Redis with a 32 bit target you need to rebuild it
with a 64 bit target, or the other way around, you need to perform a with a 64 bit target, or the other way around, you need to perform a
...@@ -99,7 +109,7 @@ the following steps: ...@@ -99,7 +109,7 @@ the following steps:
`make CFLAGS="-m32 -march=native" LDFLAGS="-m32"` `make CFLAGS="-m32 -march=native" LDFLAGS="-m32"`
Allocator Allocator
--------- ---
Selecting a non-default memory allocator when building Redis is done by setting Selecting a non-default memory allocator when building Redis is done by setting
the `MALLOC` environment variable. Redis is compiled and linked against libc the `MALLOC` environment variable. Redis is compiled and linked against libc
...@@ -116,7 +126,7 @@ To compile against jemalloc on Mac OS X systems, use: ...@@ -116,7 +126,7 @@ To compile against jemalloc on Mac OS X systems, use:
% make MALLOC=jemalloc % make MALLOC=jemalloc
Monotonic clock Monotonic clock
--------------- ---
By default, Redis will build using the POSIX clock_gettime function as the By default, Redis will build using the POSIX clock_gettime function as the
monotonic clock source. On most modern systems, the internal processor clock monotonic clock source. On most modern systems, the internal processor clock
...@@ -128,7 +138,7 @@ To build with support for the processor's internal instruction clock, use: ...@@ -128,7 +138,7 @@ To build with support for the processor's internal instruction clock, use:
% make CFLAGS="-DUSE_PROCESSOR_CLOCK" % make CFLAGS="-DUSE_PROCESSOR_CLOCK"
Verbose build Verbose build
------------- ---
Redis will build with a user-friendly colorized output by default. Redis will build with a user-friendly colorized output by default.
If you want to see a more verbose output, use the following: If you want to see a more verbose output, use the following:
...@@ -136,7 +146,7 @@ If you want to see a more verbose output, use the following: ...@@ -136,7 +146,7 @@ If you want to see a more verbose output, use the following:
% make V=1 % make V=1
Running Redis Running Redis
------------- ---
To run Redis with the default configuration, just type: To run Redis with the default configuration, just type:
...@@ -158,14 +168,14 @@ as options using the command line. Examples: ...@@ -158,14 +168,14 @@ as options using the command line. Examples:
All the options in redis.conf are also supported as options using the command All the options in redis.conf are also supported as options using the command
line, with exactly the same name. line, with exactly the same name.
Running Redis with TLS: Running Redis with TLS
------------------ ---
Please consult the [TLS.md](TLS.md) file for more information on Please consult the [TLS.md](TLS.md) file for more information on
how to use Redis with TLS. how to use Redis with TLS.
Playing with Redis Playing with Redis
------------------ ---
You can use redis-cli to play with Redis. Start a redis-server instance, You can use redis-cli to play with Redis. Start a redis-server instance,
then in another terminal try the following: then in another terminal try the following:
...@@ -187,7 +197,7 @@ then in another terminal try the following: ...@@ -187,7 +197,7 @@ then in another terminal try the following:
You can find the list of all the available commands at https://redis.io/commands. You can find the list of all the available commands at https://redis.io/commands.
Installing Redis Installing Redis
----------------- ---
In order to install Redis binaries into /usr/local/bin, just use: In order to install Redis binaries into /usr/local/bin, just use:
...@@ -215,15 +225,15 @@ You'll be able to stop and start Redis using the script named ...@@ -215,15 +225,15 @@ You'll be able to stop and start Redis using the script named
`/etc/init.d/redis_<portnumber>`, for instance `/etc/init.d/redis_6379`. `/etc/init.d/redis_<portnumber>`, for instance `/etc/init.d/redis_6379`.
Code contributions Code contributions
----------------- ---
By contributing code to the Redis project in any form, including sending a pull request via GitHub, By contributing code to the Redis project in any form, including sending a pull request via GitHub,
a code fragment or patch via private email or public discussion groups, you agree to release your a code fragment or patch via private email or public discussion groups, you agree to release your
code under the terms of the [Redis Software Grant and Contributor License Agreement][1]. Redis software code under the terms of the [Redis Software Grant and Contributor License Agreement][1]. Redis software
contains contributions to the original Redis core project, which are owned by their contributors and contains contributions to the original Redis core project, which are owned by their contributors and
licensed under the 3BSD license. Any copy of that license in this repository applies only to those licensed under the 3BSD license. Any copy of that license in this repository applies only to those
contributions. Redis releases all Redis project versions from 7.4.x and thereafter under the contributions. Redis releases all Redis Community Edition versions from 7.4.x and thereafter under the
RSALv2/SSPL dual-license as described in the [LICENSE.txt][2] file included in the Redis source distribution. RSALv2/SSPL dual-license as described in the [LICENSE.txt][2] file included in the Redis Community Edition source distribution.
Please see the [CONTRIBUTING.md][1] file in this source distribution for more information. For Please see the [CONTRIBUTING.md][1] file in this source distribution for more information. For
security bugs and vulnerabilities, please see [SECURITY.md][3]. security bugs and vulnerabilities, please see [SECURITY.md][3].
...@@ -233,7 +243,7 @@ security bugs and vulnerabilities, please see [SECURITY.md][3]. ...@@ -233,7 +243,7 @@ security bugs and vulnerabilities, please see [SECURITY.md][3].
[3]: https://github.com/redis/redis/blob/unstable/SECURITY.md [3]: https://github.com/redis/redis/blob/unstable/SECURITY.md
Redis Trademarks Redis Trademarks
---------------- ---
The purpose of a trademark is to identify the goods and services of a person or company without The purpose of a trademark is to identify the goods and services of a person or company without
causing confusion. As the registered owner of its name and logo, Redis accepts certain limited uses causing confusion. As the registered owner of its name and logo, Redis accepts certain limited uses
...@@ -243,7 +253,7 @@ Guidelines available at: https://redis.com/legal/trademark-guidelines/. ...@@ -243,7 +253,7 @@ Guidelines available at: https://redis.com/legal/trademark-guidelines/.
Redis internals Redis internals
=== ===
If you are reading this README you are likely in front of a Github page If you are reading this README you are likely in front of a GitHub page
or you just untarred the Redis distribution tar ball. In both the cases or you just untarred the Redis distribution tar ball. In both the cases
you are basically one step away from the source code, so here we explain you are basically one step away from the source code, so here we explain
the Redis source code layout, what is in each file as a general idea, the the Redis source code layout, what is in each file as a general idea, the
...@@ -259,7 +269,7 @@ Source code layout ...@@ -259,7 +269,7 @@ Source code layout
The Redis root directory just contains this README, the Makefile which The Redis root directory just contains this README, the Makefile which
calls the real Makefile inside the `src` directory and an example calls the real Makefile inside the `src` directory and an example
configuration for Redis and Sentinel. You can find a few shell configuration for Redis and Redis Sentinel. You can find a few shell
scripts that are used in order to execute the Redis, Redis Cluster and scripts that are used in order to execute the Redis, Redis Cluster and
Redis Sentinel unit tests, which are implemented inside the `tests` Redis Sentinel unit tests, which are implemented inside the `tests`
directory. directory.
......
...@@ -3,8 +3,8 @@ All rights reserved. ...@@ -3,8 +3,8 @@ All rights reserved.
Note: Continued Applicability of the BSD-3-Clause License Note: Continued Applicability of the BSD-3-Clause License
Despite the shift to the dual-licensing model with Redis version 7.4 (RSALv2 or SSPLv1), portions of Despite the shift to the dual-licensing model with Redis Community Edition version 7.4 (RSALv2 or SSPLv1), portions of
Redis remain available subject to the BSD-3-Clause License (BSD). See below for the full BSD Redis Community Edition remain available subject to the BSD-3-Clause License (BSD). See below for the full BSD
license: license:
Redistribution and use in source and binary forms, with or without modification, are permitted Redistribution and use in source and binary forms, with or without modification, are permitted
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
## Supported Versions ## Supported Versions
Redis is generally backwards compatible with very few exceptions, so we Redis is generally backward compatible with very few exceptions, so we
recommend users to always use the latest version to experience stability, recommend users to always use the latest version to experience stability,
performance and security. performance and security.
...@@ -11,10 +11,11 @@ unless this is not possible or feasible with a reasonable effort. ...@@ -11,10 +11,11 @@ unless this is not possible or feasible with a reasonable effort.
| Version | Supported | | Version | Supported |
| ------- | ------------------ | | ------- | ------------------ |
| 7.4.x | :white_check_mark: |
| 7.2.x | :white_check_mark: | | 7.2.x | :white_check_mark: |
| 7.0.x | :white_check_mark: | | < 7.2.x | :x: |
| 6.2.x | :white_check_mark: | | 6.2.x | :white_check_mark: |
| < 6.2 | :x: | | < 6.2.x | :x: |
## Reporting a Vulnerability ## Reporting a Vulnerability
...@@ -34,10 +35,5 @@ This process involves providing an early notification about the vulnerability, ...@@ -34,10 +35,5 @@ This process involves providing an early notification about the vulnerability,
its impact and mitigations to a short list of vendors under a time-limited its impact and mitigations to a short list of vendors under a time-limited
embargo on public disclosure. embargo on public disclosure.
Vendors on the list are individuals or organizations that maintain Redis
distributions or provide Redis as a service, who have third party users who
will benefit from the vendor's ability to prepare for a new version or deploy a
fix early.
If you believe you should be on the list, please contact us and we will If you believe you should be on the list, please contact us and we will
consider your request based on the above criteria. consider your request based on the above criteria.
...@@ -9,8 +9,8 @@ ...@@ -9,8 +9,8 @@
const char *ascii_logo = const char *ascii_logo =
" _._ \n" " _._ \n"
" _.-``__ ''-._ \n" " _.-``__ ''-._ \n"
" _.-`` `. `_. ''-._ Redis %s (%s/%d) %s bit\n" " _.-`` `. `_. ''-._ Redis Community Edition \n"
" .-`` .-```. ```\\/ _.,_ ''-._ \n" " .-`` .-```. ```\\/ _.,_ ''-._ %s (%s/%d) %s bit\n"
" ( ' , .-` | `, ) Running in %s mode\n" " ( ' , .-` | `, ) Running in %s mode\n"
" |`-._`-...-` __...-.``-._|'` _.-'| Port: %d\n" " |`-._`-...-` __...-.``-._|'` _.-'| Port: %d\n"
" | `-._ `._ / _.-' | PID: %ld\n" " | `-._ `._ / _.-' | PID: %ld\n"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment