redisson/redisson-spring-boot-starter
Nikita Koksharov 800d650341
Update README.md
..
src
README.md Update README.md
pom.xml

README.md

Spring Boot Starter

Integrates Redisson with Spring Boot library. Depends on Spring Data Redis module.

Supports Spring Boot 1.3.x, 1.4.x, 1.5.x, 2.0.x, 2.1.x

Please consider Redisson PRO version for advanced features and support by SLA.

Usage

1. Add redisson-spring-boot-starter dependency into your project:

  1. For JDK 1.8+

    Maven

    <dependency>
        <groupId>org.redisson</groupId>
        <artifactId>redisson-spring-boot-starter</artifactId>
        <version>3.9.1</version>
    </dependency>
    

    Gradle

    compile 'org.redisson:redisson-spring-boot-starter:3.9.1'
    
  2. For JDK 1.6+

    Maven

    <dependency>
        <groupId>org.redisson</groupId>
        <artifactId>redisson-spring-boot-starter</artifactId>
        <version>2.14.1</version>
    </dependency>
    

    Gradle

    compile 'org.redisson:redisson-spring-boot-starter:2.14.1'
    

2. Add settings into application.settings file

Common spring boot settings or Redisson settings could be used.

# common spring boot settings

spring.redis.database=
spring.redis.host=
spring.redis.port=
spring.redis.password=
spring.redis.ssl=
spring.redis.timeout=
spring.redis.cluster.nodes=
spring.redis.sentinel.master=
spring.redis.sentinel.nodes=

# Redisson settings

#path to redisson.yaml or redisson.json
spring.redis.redisson.config=classpath:redisson.yaml

3. Get access to Redisson through spring bean with RedissonClient interface