You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
redisson/redisson-spring-boot-starter
Nikita Koksharov 5c06df9510
Update README.md
6 years ago
..
src License header updated 6 years ago
README.md Update README.md 6 years ago
pom.xml [maven-release-plugin] prepare for next development iteration 6 years ago

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.10.2</version>
    </dependency>
    

    Gradle

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

    Maven

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

    Gradle

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

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. Use Redisson through spring bean with RedissonClient interface or RedisTemplate/ReactiveRedisTemplate objects