This repository has been archived by the owner on Feb 20, 2021. It is now read-only.
forked from redis/redis
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f7e6eea
commit def0757
Showing
7 changed files
with
72 additions
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,191 +1,63 @@ | ||
This README is just a fast *quick start* document. You can find more detailed documentation at http://redis.io. | ||
[![Windows Status](http://img.shields.io/appveyor/ci/MSOpenTech-lab/redis.svg?style=flat-square)](https://ci.appveyor.com/project/MSOpenTech-lab/redis) [![NuGet version](http://img.shields.io/nuget/v/redis-64.svg?style=flat-square)](http://www.nuget.org/packages/redis-64/) [![Chocolatey version](http://img.shields.io/chocolatey/v/redis-64.svg?style=flat-square)](http://www.chocolatey.org/packages/redis-64/) [![Chocolatey downloads](http://img.shields.io/chocolatey/dt/redis-64.svg?style=flat-square)](http://www.chocolatey.org/packages/redis-64/) | ||
|
||
What is Redis? | ||
-------------- | ||
## Redis on Windows | ||
|
||
Redis is often referred 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. | ||
- This is a port for Windows based on [Redis](https://github.com/antirez/redis). | ||
- We officially support the 64-bit version only. Although you can build the 32-bit version from source if desired. | ||
- You can download the latest unsigned binaries and the unsigned MSI installer from the [release page](http://github.com/MSOpenTech/redis/releases "Release page"). | ||
- For releases prior to 2.8.17.1, the binaries can found in a zip file inside the source archive, under the bin/release folder. | ||
- Signed binaries are available through [NuGet](https://www.nuget.org/packages/Redis-64/) and [Chocolatey](https://chocolatey.org/packages/redis-64). | ||
- Redis can be installed as a Windows Service. | ||
|
||
Data structures implemented into Redis have a few special properties: | ||
## Windows-specific changes | ||
- There is a replacement for the UNIX fork() API that simulates the copy-on-write behavior using a memory mapped file on 2.8. Version 3.0 is using a similar behavior but dropped the memory mapped file in favor of the system paging file. | ||
- In 3.0 we switch the default memory allocator from dlmalloc to jemalloc that is supposed to do a better job at managing the heap fragmentation. | ||
- Because Redis makes some assumptions about the values of file descriptors, we have built a virtual file descriptor mapping layer. | ||
|
||
* Redis cares to store them on disk, even if they are always served and modified into the server memory. This means that Redis is fast, but that is also non-volatile. | ||
* Implementation of data structures stress on memory efficiency, so data structures inside Redis will likely use less memory compared to the same data structure modeled using an high level programming language. | ||
* Redis offers a number of features that are natural to find in a database, like replication, tunable levels of durability, cluster, high availability. | ||
## Redis release notes | ||
|
||
Another good example is to think of Redis as a more complex version of memcached, where the operations are not just SETs and GETs, but operations to work with complex data types like Lists, Sets, ordered data structures, and so forth. | ||
There are two current active branches: 2.8 and 3.0. | ||
|
||
If you want to know more, this is a list of selected starting points: | ||
- Redis on UNIX [2.8 release notes](https://raw.githubusercontent.com/antirez/redis/2.8/00-RELEASENOTES) | ||
- Redis on Windows [2.8 release notes](https://raw.githubusercontent.com/MSOpenTech/redis/2.8/Redis%20on%20Windows%20Release%20Notes.md) | ||
- Redis on UNIX [3.0 release notes](https://raw.githubusercontent.com/antirez/redis/3.0/00-RELEASENOTES) | ||
- Redis on Windows [3.0 release notes](https://raw.githubusercontent.com/MSOpenTech/redis/3.0/Redis%20on%20Windows%20Release%20Notes.md) | ||
|
||
* Introduction to Redis data types. http://redis.io/topics/data-types-intro | ||
* Try Redis directly inside your browser. http://try.redis.io | ||
* The full list of Redis commands. http://redis.io/commands | ||
* There is much more inside the Redis official documentation. http://redis.io/documentation | ||
## How to configure and deploy Redis on Windows | ||
|
||
Building Redis | ||
-------------- | ||
- [Memory Configuration for 2.8](https://github.com/MSOpenTech/redis/wiki/Memory-Configuration "Memory Configuration") | ||
- [Memory Configuration for 3.0](https://github.com/MSOpenTech/redis/wiki/Memory-Configuration-For-Redis-3.0 "Memory Configuration") | ||
- [Windows Service Documentation](https://raw.githubusercontent.com/MSOpenTech/redis/3.0/Windows%20Service%20Documentation.md "Windows Service Documentation") | ||
- [Redis on Windows](https://raw.githubusercontent.com/MSOpenTech/redis/2.8/Redis%20on%20Windows.md "Redis on Windows") | ||
- [Windows Service Documentation](https://raw.githubusercontent.com/MSOpenTech/redis/2.8/Windows%20Service%20Documentation.md "Windows Service Documentation") | ||
|
||
Redis can be compiled and used on Linux, OSX, OpenBSD, NetBSD, FreeBSD. | ||
We support big endian and little endian architectures, and both 32 bit | ||
and 64 bit systems. | ||
## How to build Redis using Visual Studio | ||
|
||
It may compile on Solaris derived systems (for instance SmartOS) but our | ||
support for this platform is *best effort* and Redis is not guaranteed to | ||
work as well as in Linux, OSX, and \*BSD there. | ||
You can use the free [Visual Studio 2013 Community Edition](http://www.visualstudio.com/products/visual-studio-community-vs). Regardless which Visual Studio edition you use, make sure you have updated to Update 5, otherwise you will get a "illegal use of this type as an expression" error. | ||
|
||
It is as simple as: | ||
- Open the solution file msvs\redisserver.sln in Visual Studio, select a build configuration (Debug or Release) and target (x64) then build. | ||
|
||
% make | ||
This should create the following executables in the msvs\$(Target)\$(Configuration) folder: | ||
|
||
You can run a 32 bit Redis binary using: | ||
- redis-server.exe | ||
- redis-benchmark.exe | ||
- redis-cli.exe | ||
- redis-check-dump.exe | ||
- redis-check-aof.exe | ||
|
||
% make 32bit | ||
## Testing | ||
|
||
After building Redis is a good idea to test it, using: | ||
To run the Redis test suite some manual work is required: | ||
|
||
% make test | ||
- The tests assume that the binaries are in the src folder. Use mklink to create a symbolic link to the files in the msvs\x64\Debug|Release folders. You will | ||
need symbolic links for src\redis-server, src\redis-benchmark, src\redis-check-aof, src\redis-check-dump, src\redis-cli, and src\redis-sentinel. | ||
- The tests make use of TCL. This must be installed separately. | ||
- To run the cluster tests against 3.0, Ruby On Windows is required. | ||
- To run the tests you need to have a Unix shell on your machine, or MinGW tools in your path. To execute the tests, run the following command: | ||
"tclsh8.5.exe tests/test_helper.tcl --clients N", where N is the number of parallel clients . If a Unix shell is not installed you may see the | ||
following error message: "couldn't execute "cat": no such file or directory". | ||
- By default the test suite launches 16 parallel tests, but 2 is the suggested number. | ||
|
||
## Code of Conduct | ||
|
||
Fixing build problems with dependencies or cached build options | ||
--------- | ||
|
||
Redis has some dependencies which are included into the `deps` directory. | ||
`make` does not rebuild dependencies automatically, even if something in the | ||
source code of dependencies is changed. | ||
|
||
When you update the source code with `git pull` or when code inside the | ||
dependencies tree is modified in any other way, make sure to use the following | ||
command in order to really clean everything and rebuild from scratch: | ||
|
||
make distclean | ||
|
||
This will clean: jemalloc, lua, hiredis, linenoise. | ||
|
||
Also if you force certain build options like 32bit target, no C compiler | ||
optimizations (for debugging purposes), and other similar build time options, | ||
those options are cached indefinitely until you issue a `make distclean` | ||
command. | ||
|
||
Fixing problems building 32 bit binaries | ||
--------- | ||
|
||
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 | ||
`make distclean` in the root directory of the Redis distribution. | ||
|
||
In case of build errors when trying to build a 32 bit binary of Redis, try | ||
the following steps: | ||
|
||
* Install the packages libc6-dev-i386 (also try g++-multilib). | ||
* Try using the following command line instead of `make 32bit`: | ||
`make CFLAGS="-m32 -march=native" LDFLAGS="-m32"` | ||
|
||
Allocator | ||
--------- | ||
|
||
Selecting a non-default memory allocator when building Redis is done by setting | ||
the `MALLOC` environment variable. Redis is compiled and linked against libc | ||
malloc by default, with the exception of jemalloc being the default on Linux | ||
systems. This default was picked because jemalloc has proven to have fewer | ||
fragmentation problems than libc malloc. | ||
|
||
To force compiling against libc malloc, use: | ||
|
||
% make MALLOC=libc | ||
|
||
To compile against jemalloc on Mac OS X systems, use: | ||
|
||
% make MALLOC=jemalloc | ||
|
||
Verbose build | ||
------------- | ||
|
||
Redis will build with a user friendly colorized output by default. | ||
If you want to see a more verbose output use the following: | ||
|
||
% make V=1 | ||
|
||
Running Redis | ||
------------- | ||
|
||
To run Redis with the default configuration just type: | ||
|
||
% cd src | ||
% ./redis-server | ||
|
||
If you want to provide your redis.conf, you have to run it using an additional | ||
parameter (the path of the configuration file): | ||
|
||
% cd src | ||
% ./redis-server /path/to/redis.conf | ||
|
||
It is possible to alter the Redis configuration passing parameters directly | ||
as options using the command line. Examples: | ||
|
||
% ./redis-server --port 9999 --slaveof 127.0.0.1 6379 | ||
% ./redis-server /etc/redis/6379.conf --loglevel debug | ||
|
||
All the options in redis.conf are also supported as options using the command | ||
line, with exactly the same name. | ||
|
||
Playing with Redis | ||
------------------ | ||
|
||
You can use redis-cli to play with Redis. Start a redis-server instance, | ||
then in another terminal try the following: | ||
|
||
% cd src | ||
% ./redis-cli | ||
redis> ping | ||
PONG | ||
redis> set foo bar | ||
OK | ||
redis> get foo | ||
"bar" | ||
redis> incr mycounter | ||
(integer) 1 | ||
redis> incr mycounter | ||
(integer) 2 | ||
redis> | ||
|
||
You can find the list of all the available commands at http://redis.io/commands. | ||
|
||
Installing Redis | ||
----------------- | ||
|
||
In order to install Redis binaries into /usr/local/bin just use: | ||
|
||
% make install | ||
|
||
You can use `make PREFIX=/some/other/directory install` if you wish to use a | ||
different destination. | ||
|
||
Make install will just install binaries in your system, but will not configure | ||
init scripts and configuration files in the appropriate place. This is not | ||
needed if you want just to play a bit with Redis, but if you are installing | ||
it the proper way for a production system, we have a script doing this | ||
for Ubuntu and Debian systems: | ||
|
||
% cd utils | ||
% ./install_server.sh | ||
|
||
The script will ask you a few questions and will setup everything you need | ||
to run Redis properly as a background daemon that will start again on | ||
system reboots. | ||
|
||
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`. | ||
|
||
Code contributions | ||
--- | ||
|
||
Note: 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 code under the terms | ||
of the BSD license that you can find in the [COPYING][1] file included in the Redis | ||
source distribution. | ||
|
||
Please see the [CONTRIBUTING][2] file in this source distribution for more | ||
information. | ||
|
||
Enjoy! | ||
|
||
[1]: https://github.com/antirez/redis/blob/unstable/COPYING | ||
[2]: https://github.com/antirez/redis/blob/unstable/CONTRIBUTING | ||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
#define REDIS_VERSION "3.2.1" | ||
#define REDIS_VERSION "3.2.100" |