Redis 镜像 好像 Redis 没有默认的配置文件，如果要提供自己的配置文件需要在源码或则安装目录下复制配置文件，可以手动找到你当前版本的 redis 下载后拿到配置文件 Redis 的详细使用可以参考此文章

  1. services:
  2.   redis:
  3.     image: redis:6.2.6
  4.     container_name: redis
  5.     volumes: 
  6.       - ./redis/data:/data
  7.       - ./redis/conf:/usr/local/etc/redis
  8.       - ./redis/logs:/logs
  9.     command: redis-server /usr/local/etc/redis/redis.conf
  10.     ports:
  11.       - 6379:6379

上面配置的含义：

  • ./data:/data 将数据挂载出来，比如 dump.rdb 文件就会写到该目录下
  • ./conf:/usr/local/etc/redis： 这个只是将该目录挂载出来了，里面需要我们将配置文件写入，而不是 redis 会主动将配置文件写到该目录中，使用自定义配置文件还需要配合 command: redis-server /usr/local/etc/redis/redis.conf 指定
  • ./logs:/logs 创建一个 logs 目录，在配置文件中，我们将 redis 日志写入到此目录下

针对于 redis 配置文件的简单修改：redis.conf

  1. # 设置为后台运行
  2. daemonize yes
  4. # 配置那些服务能链接到 redis，默认是本机，设置为所有机器都可访问
  5. # bind 127.0.0.1
  6. bind 0.0.0.0
  8. # 设置 redis 的访问密码，默认是不需要密码
  9. requirepass 123456
  11. # 将日志文件打印出来，如果配置了这个，docker 容器就看不了日志了
  12. # logfile "/logs/redis.log"

:::tips 上面的配置是要修改的配置，不能直接使用，要拿到 redis 的默认配置文件，在这个基础上修改之后才能使用。
否则你在启动 redis 的时候可能就直接会出现一句日志 redis exited with code 0 然后容器就退出了（这个日志信息还是在 docker desktop 桌面版的软件上才能看到） :::

redis.conf 默认配置文件

下面给出 6.2.6 版本的 redis.conf 文件, 已经将上面修改之后的参数在下面配置文件中修改好了，可以直接复制过去就可以使用

  1. # Redis configuration file example.
  2. #
  3. # Note that in order to read the configuration file, Redis must be
  4. # started with the file path as first argument:
  5. #
  6. # ./redis-server /path/to/redis.conf
  8. # Note on units: when memory size is needed, it is possible to specify
  9. # it in the usual form of 1k 5GB 4M and so forth:
  10. #
  11. # 1k => 1000 bytes
  12. # 1kb => 1024 bytes
  13. # 1m => 1000000 bytes
  14. # 1mb => 1024*1024 bytes
  15. # 1g => 1000000000 bytes
  16. # 1gb => 1024*1024*1024 bytes
  17. #
  18. # units are case insensitive so 1GB 1Gb 1gB are all the same.
  20. ################################## INCLUDES ###################################
  22. # Include one or more other config files here.  This is useful if you
  23. # have a standard template that goes to all Redis servers but also need
  24. # to customize a few per-server settings.  Include files can include
  25. # other files, so use this wisely.
  26. #
  27. # Note that option "include" won't be rewritten by command "CONFIG REWRITE"
  28. # from admin or Redis Sentinel. Since Redis always uses the last processed
  29. # line as value of a configuration directive, you'd better put includes
  30. # at the beginning of this file to avoid overwriting config change at runtime.
  31. #
  32. # If instead you are interested in using includes to override configuration
  33. # options, it is better to use include as the last line.
  34. #
  35. # include /path/to/local.conf
  36. # include /path/to/other.conf
  38. ################################## MODULES #####################################
  40. # Load modules at startup. If the server is not able to load modules
  41. # it will abort. It is possible to use multiple loadmodule directives.
  42. #
  43. # loadmodule /path/to/my_module.so
  44. # loadmodule /path/to/other_module.so
  46. ################################## NETWORK #####################################
  48. # By default, if no "bind" configuration directive is specified, Redis listens
  49. # for connections from all available network interfaces on the host machine.
  50. # It is possible to listen to just one or multiple selected interfaces using
  51. # the "bind" configuration directive, followed by one or more IP addresses.
  52. # Each address can be prefixed by "-", which means that redis will not fail to
  53. # start if the address is not available. Being not available only refers to
  54. # addresses that does not correspond to any network interfece. Addresses that
  55. # are already in use will always fail, and unsupported protocols will always BE
  56. # silently skipped.
  57. #
  58. # Examples:
  59. #
  60. # bind 192.168.1.100 10.0.0.1     # listens on two specific IPv4 addresses
  61. # bind 127.0.0.1 ::1              # listens on loopback IPv4 and IPv6
  62. # bind * -::*                     # like the default, all available interfaces
  63. #
  64. # ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the
  65. # internet, binding to all the interfaces is dangerous and will expose the
  66. # instance to everybody on the internet. So by default we uncomment the
  67. # following bind directive, that will force Redis to listen only on the
  68. # IPv4 and IPv6 (if available) loopback interface addresses (this means Redis
  69. # will only be able to accept client connections from the same host that it is
  70. # running on).
  71. #
  72. # IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES
  73. # JUST COMMENT OUT THE FOLLOWING LINE.
  74. # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  75. # bind 127.0.0.1 -::1
  76. bind 0.0.0.0
  78. # Protected mode is a layer of security protection, in order to avoid that
  79. # Redis instances left open on the internet are accessed and exploited.
  80. #
  81. # When protected mode is on and if:
  82. #
  83. # 1) The server is not binding explicitly to a set of addresses using the
  84. #    "bind" directive.
  85. # 2) No password is configured.
  86. #
  87. # The server only accepts connections from clients connecting from the
  88. # IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain
  89. # sockets.
  90. #
  91. # By default protected mode is enabled. You should disable it only if
  92. # you are sure you want clients from other hosts to connect to Redis
  93. # even if no authentication is configured, nor a specific set of interfaces
  94. # are explicitly listed using the "bind" directive.
  95. protected-mode yes
  97. # Accept connections on the specified port, default is 6379 (IANA #815344).
  98. # If port 0 is specified Redis will not listen on a TCP socket.
  99. port 6379
  101. # TCP listen() backlog.
  102. #
  103. # In high requests-per-second environments you need a high backlog in order
  104. # to avoid slow clients connection issues. Note that the Linux kernel
  105. # will silently truncate it to the value of /proc/sys/net/core/somaxconn so
  106. # make sure to raise both the value of somaxconn and tcp_max_syn_backlog
  107. # in order to get the desired effect.
  108. tcp-backlog 511
  110. # Unix socket.
  111. #
  112. # Specify the path for the Unix socket that will be used to listen for
  113. # incoming connections. There is no default, so Redis will not listen
  114. # on a unix socket when not specified.
  115. #
  116. # unixsocket /run/redis.sock
  117. # unixsocketperm 700
  119. # Close the connection after a client is idle for N seconds (0 to disable)
  120. timeout 0
  122. # TCP keepalive.
  123. #
  124. # If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence
  125. # of communication. This is useful for two reasons:
  126. #
  127. # 1) Detect dead peers.
  128. # 2) Force network equipment in the middle to consider the connection to be
  129. #    alive.
  130. #
  131. # On Linux, the specified value (in seconds) is the period used to send ACKs.
  132. # Note that to close the connection the double of the time is needed.
  133. # On other kernels the period depends on the kernel configuration.
  134. #
  135. # A reasonable value for this option is 300 seconds, which is the new
  136. # Redis default starting with Redis 3.2.1.
  137. tcp-keepalive 300
  139. ################################# TLS/SSL #####################################
  141. # By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration
  142. # directive can be used to define TLS-listening ports. To enable TLS on the
  143. # default port, use:
  144. #
  145. # port 0
  146. # tls-port 6379
  148. # Configure a X.509 certificate and private key to use for authenticating the
  149. # server to connected clients, masters or cluster peers.  These files should be
  150. # PEM formatted.
  151. #
  152. # tls-cert-file redis.crt 
  153. # tls-key-file redis.key
  154. #
  155. # If the key file is encrypted using a passphrase, it can be included here
  156. # as well.
  157. #
  158. # tls-key-file-pass secret
  160. # Normally Redis uses the same certificate for both server functions (accepting
  161. # connections) and client functions (replicating from a master, establishing
  162. # cluster bus connections, etc.).
  163. #
  164. # Sometimes certificates are issued with attributes that designate them as
  165. # client-only or server-only certificates. In that case it may be desired to use
  166. # different certificates for incoming (server) and outgoing (client)
  167. # connections. To do that, use the following directives:
  168. #
  169. # tls-client-cert-file client.crt
  170. # tls-client-key-file client.key
  171. #
  172. # If the key file is encrypted using a passphrase, it can be included here
  173. # as well.
  174. #
  175. # tls-client-key-file-pass secret
  177. # Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange:
  178. #
  179. # tls-dh-params-file redis.dh
  181. # Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL
  182. # clients and peers.  Redis requires an explicit configuration of at least one
  183. # of these, and will not implicitly use the system wide configuration.
  184. #
  185. # tls-ca-cert-file ca.crt
  186. # tls-ca-cert-dir /etc/ssl/certs
  188. # By default, clients (including replica servers) on a TLS port are required
  189. # to authenticate using valid client side certificates.
  190. #
  191. # If "no" is specified, client certificates are not required and not accepted.
  192. # If "optional" is specified, client certificates are accepted and must be
  193. # valid if provided, but are not required.
  194. #
  195. # tls-auth-clients no
  196. # tls-auth-clients optional
  198. # By default, a Redis replica does not attempt to establish a TLS connection
  199. # with its master.
  200. #
  201. # Use the following directive to enable TLS on replication links.
  202. #
  203. # tls-replication yes
  205. # By default, the Redis Cluster bus uses a plain TCP connection. To enable
  206. # TLS for the bus protocol, use the following directive:
  207. #
  208. # tls-cluster yes
  210. # By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended
  211. # that older formally deprecated versions are kept disabled to reduce the attack surface.
  212. # You can explicitly specify TLS versions to support.
  213. # Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2",
  214. # "TLSv1.3" (OpenSSL >= 1.1.1) or any combination.
  215. # To enable only TLSv1.2 and TLSv1.3, use:
  216. #
  217. # tls-protocols "TLSv1.2 TLSv1.3"
  219. # Configure allowed ciphers.  See the ciphers(1ssl) manpage for more information
  220. # about the syntax of this string.
  221. #
  222. # Note: this configuration applies only to <= TLSv1.2.
  223. #
  224. # tls-ciphers DEFAULT:!MEDIUM
  226. # Configure allowed TLSv1.3 ciphersuites.  See the ciphers(1ssl) manpage for more
  227. # information about the syntax of this string, and specifically for TLSv1.3
  228. # ciphersuites.
  229. #
  230. # tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256
  232. # When choosing a cipher, use the server's preference instead of the client
  233. # preference. By default, the server follows the client's preference.
  234. #
  235. # tls-prefer-server-ciphers yes
  237. # By default, TLS session caching is enabled to allow faster and less expensive
  238. # reconnections by clients that support it. Use the following directive to disable
  239. # caching.
  240. #
  241. # tls-session-caching no
  243. # Change the default number of TLS sessions cached. A zero value sets the cache
  244. # to unlimited size. The default size is 20480.
  245. #
  246. # tls-session-cache-size 5000
  248. # Change the default timeout of cached TLS sessions. The default timeout is 300
  249. # seconds.
  250. #
  251. # tls-session-cache-timeout 60
  253. ################################# GENERAL #####################################
  255. # By default Redis does not run as a daemon. Use 'yes' if you need it.
  256. # Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
  257. # When Redis is supervised by upstart or systemd, this parameter has no impact.
  258. daemonize no
  260. # If you run Redis from upstart or systemd, Redis can interact with your
  261. # supervision tree. Options:
  262. #   supervised no      - no supervision interaction
  263. #   supervised upstart - signal upstart by putting Redis into SIGSTOP mode
  264. #                        requires "expect stop" in your upstart job config
  265. #   supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET
  266. #                        on startup, and updating Redis status on a regular
  267. #                        basis.
  268. #   supervised auto    - detect upstart or systemd method based on
  269. #                        UPSTART_JOB or NOTIFY_SOCKET environment variables
  270. # Note: these supervision methods only signal "process is ready."
  271. #       They do not enable continuous pings back to your supervisor.
  272. #
  273. # The default is "no". To run under upstart/systemd, you can simply uncomment
  274. # the line below:
  275. #
  276. # supervised auto
  278. # If a pid file is specified, Redis writes it where specified at startup
  279. # and removes it at exit.
  280. #
  281. # When the server runs non daemonized, no pid file is created if none is
  282. # specified in the configuration. When the server is daemonized, the pid file
  283. # is used even if not specified, defaulting to "/var/run/redis.pid".
  284. #
  285. # Creating a pid file is best effort: if Redis is not able to create it
  286. # nothing bad happens, the server will start and run normally.
  287. #
  288. # Note that on modern Linux systems "/run/redis.pid" is more conforming
  289. # and should be used instead.
  290. pidfile /var/run/redis_6379.pid
  292. # Specify the server verbosity level.
  293. # This can be one of:
  294. # debug (a lot of information, useful for development/testing)
  295. # verbose (many rarely useful info, but not a mess like the debug level)
  296. # notice (moderately verbose, what you want in production probably)
  297. # warning (only very important / critical messages are logged)
  298. loglevel notice
  300. # Specify the log file name. Also the empty string can be used to force
  301. # Redis to log on the standard output. Note that if you use standard
  302. # output for logging but daemonize, logs will be sent to /dev/null
  303. # logfile "/logs/redis.log"
  305. # To enable logging to the system logger, just set 'syslog-enabled' to yes,
  306. # and optionally update the other syslog parameters to suit your needs.
  307. # syslog-enabled no
  309. # Specify the syslog identity.
  310. # syslog-ident redis
  312. # Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7.
  313. # syslog-facility local0
  315. # To disable the built in crash log, which will possibly produce cleaner core
  316. # dumps when they are needed, uncomment the following:
  317. #
  318. # crash-log-enabled no
  320. # To disable the fast memory check that's run as part of the crash log, which
  321. # will possibly let redis terminate sooner, uncomment the following:
  322. #
  323. # crash-memcheck-enabled no
  325. # Set the number of databases. The default database is DB 0, you can select
  326. # a different one on a per-connection basis using SELECT <dbid> where
  327. # dbid is a number between 0 and 'databases'-1
  328. databases 16
  330. # By default Redis shows an ASCII art logo only when started to log to the
  331. # standard output and if the standard output is a TTY and syslog logging is
  332. # disabled. Basically this means that normally a logo is displayed only in
  333. # interactive sessions.
  334. #
  335. # However it is possible to force the pre-4.0 behavior and always show a
  336. # ASCII art logo in startup logs by setting the following option to yes.
  337. always-show-logo no
  339. # By default, Redis modifies the process title (as seen in 'top' and 'ps') to
  340. # provide some runtime information. It is possible to disable this and leave
  341. # the process name as executed by setting the following to no.
  342. set-proc-title yes
  344. # When changing the process title, Redis uses the following template to construct
  345. # the modified title.
  346. #
  347. # Template variables are specified in curly brackets. The following variables are
  348. # supported:
  349. #
  350. # {title}           Name of process as executed if parent, or type of child process.
  351. # {listen-addr}     Bind address or '*' followed by TCP or TLS port listening on, or
  352. #                   Unix socket if only that's available.
  353. # {server-mode}     Special mode, i.e. "[sentinel]" or "[cluster]".
  354. # {port}            TCP port listening on, or 0.
  355. # {tls-port}        TLS port listening on, or 0.
  356. # {unixsocket}      Unix domain socket listening on, or "".
  357. # {config-file}     Name of configuration file used.
  358. #
  359. proc-title-template "{title} {listen-addr} {server-mode}"
  361. ################################ SNAPSHOTTING  ################################
  363. # Save the DB to disk.
  364. #
  365. # save <seconds> <changes>
  366. #
  367. # Redis will save the DB if both the given number of seconds and the given
  368. # number of write operations against the DB occurred.
  369. #
  370. # Snapshotting can be completely disabled with a single empty string argument
  371. # as in following example:
  372. #
  373. # save ""
  374. #
  375. # Unless specified otherwise, by default Redis will save the DB:
  376. #   * After 3600 seconds (an hour) if at least 1 key changed
  377. #   * After 300 seconds (5 minutes) if at least 100 keys changed
  378. #   * After 60 seconds if at least 10000 keys changed
  379. #
  380. # You can set these explicitly by uncommenting the three following lines.
  381. #
  382. # save 3600 1
  383. # save 300 100
  384. # save 60 10000
  386. # By default Redis will stop accepting writes if RDB snapshots are enabled
  387. # (at least one save point) and the latest background save failed.
  388. # This will make the user aware (in a hard way) that data is not persisting
  389. # on disk properly, otherwise chances are that no one will notice and some
  390. # disaster will happen.
  391. #
  392. # If the background saving process will start working again Redis will
  393. # automatically allow writes again.
  394. #
  395. # However if you have setup your proper monitoring of the Redis server
  396. # and persistence, you may want to disable this feature so that Redis will
  397. # continue to work as usual even if there are problems with disk,
  398. # permissions, and so forth.
  399. stop-writes-on-bgsave-error yes
  401. # Compress string objects using LZF when dump .rdb databases?
  402. # By default compression is enabled as it's almost always a win.
  403. # If you want to save some CPU in the saving child set it to 'no' but
  404. # the dataset will likely be bigger if you have compressible values or keys.
  405. rdbcompression yes
  407. # Since version 5 of RDB a CRC64 checksum is placed at the end of the file.
  408. # This makes the format more resistant to corruption but there is a performance
  409. # hit to pay (around 10%) when saving and loading RDB files, so you can disable it
  410. # for maximum performances.
  411. #
  412. # RDB files created with checksum disabled have a checksum of zero that will
  413. # tell the loading code to skip the check.
  414. rdbchecksum yes
  416. # Enables or disables full sanitation checks for ziplist and listpack etc when
  417. # loading an RDB or RESTORE payload. This reduces the chances of a assertion or
  418. # crash later on while processing commands.
  419. # Options:
  420. #   no         - Never perform full sanitation
  421. #   yes        - Always perform full sanitation
  422. #   clients    - Perform full sanitation only for user connections.
  423. #                Excludes: RDB files, RESTORE commands received from the master
  424. #                connection, and client connections which have the
  425. #                skip-sanitize-payload ACL flag.
  426. # The default should be 'clients' but since it currently affects cluster
  427. # resharding via MIGRATE, it is temporarily set to 'no' by default.
  428. #
  429. # sanitize-dump-payload no
  431. # The filename where to dump the DB
  432. dbfilename dump.rdb
  434. # Remove RDB files used by replication in instances without persistence
  435. # enabled. By default this option is disabled, however there are environments
  436. # where for regulations or other security concerns, RDB files persisted on
  437. # disk by masters in order to feed replicas, or stored on disk by replicas
  438. # in order to load them for the initial synchronization, should be deleted
  439. # ASAP. Note that this option ONLY WORKS in instances that have both AOF
  440. # and RDB persistence disabled, otherwise is completely ignored.
  441. #
  442. # An alternative (and sometimes better) way to obtain the same effect is
  443. # to use diskless replication on both master and replicas instances. However
  444. # in the case of replicas, diskless is not always an option.
  445. rdb-del-sync-files no
  447. # The working directory.
  448. #
  449. # The DB will be written inside this directory, with the filename specified
  450. # above using the 'dbfilename' configuration directive.
  451. #
  452. # The Append Only File will also be created inside this directory.
  453. #
  454. # Note that you must specify a directory here, not a file name.
  455. dir ./
  457. ################################# REPLICATION #################################
  459. # Master-Replica replication. Use replicaof to make a Redis instance a copy of
  460. # another Redis server. A few things to understand ASAP about Redis replication.
  461. #
  462. #   +------------------+      +---------------+
  463. #   |      Master      | ---> |    Replica    |
  464. #   | (receive writes) |      |  (exact copy) |
  465. #   +------------------+      +---------------+
  466. #
  467. # 1) Redis replication is asynchronous, but you can configure a master to
  468. #    stop accepting writes if it appears to be not connected with at least
  469. #    a given number of replicas.
  470. # 2) Redis replicas are able to perform a partial resynchronization with the
  471. #    master if the replication link is lost for a relatively small amount of
  472. #    time. You may want to configure the replication backlog size (see the next
  473. #    sections of this file) with a sensible value depending on your needs.
  474. # 3) Replication is automatic and does not need user intervention. After a
  475. #    network partition replicas automatically try to reconnect to masters
  476. #    and resynchronize with them.
  477. #
  478. # replicaof <masterip> <masterport>
  480. # If the master is password protected (using the "requirepass" configuration
  481. # directive below) it is possible to tell the replica to authenticate before
  482. # starting the replication synchronization process, otherwise the master will
  483. # refuse the replica request.
  484. #
  485. # masterauth <master-password>
  486. #
  487. # However this is not enough if you are using Redis ACLs (for Redis version
  488. # 6 or greater), and the default user is not capable of running the PSYNC
  489. # command and/or other commands needed for replication. In this case it's
  490. # better to configure a special user to use with replication, and specify the
  491. # masteruser configuration as such:
  492. #
  493. # masteruser <username>
  494. #
  495. # When masteruser is specified, the replica will authenticate against its
  496. # master using the new AUTH form: AUTH <username> <password>.
  498. # When a replica loses its connection with the master, or when the replication
  499. # is still in progress, the replica can act in two different ways:
  500. #
  501. # 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will
  502. #    still reply to client requests, possibly with out of date data, or the
  503. #    data set may just be empty if this is the first synchronization.
  504. #
  505. # 2) If replica-serve-stale-data is set to 'no' the replica will reply with
  506. #    an error "SYNC with master in progress" to all commands except:
  507. #    INFO, REPLICAOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE,
  508. #    UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST,
  509. #    HOST and LATENCY.
  510. #
  511. replica-serve-stale-data yes
  513. # You can configure a replica instance to accept writes or not. Writing against
  514. # a replica instance may be useful to store some ephemeral data (because data
  515. # written on a replica will be easily deleted after resync with the master) but
  516. # may also cause problems if clients are writing to it because of a
  517. # misconfiguration.
  518. #
  519. # Since Redis 2.6 by default replicas are read-only.
  520. #
  521. # Note: read only replicas are not designed to be exposed to untrusted clients
  522. # on the internet. It's just a protection layer against misuse of the instance.
  523. # Still a read only replica exports by default all the administrative commands
  524. # such as CONFIG, DEBUG, and so forth. To a limited extent you can improve
  525. # security of read only replicas using 'rename-command' to shadow all the
  526. # administrative / dangerous commands.
  527. replica-read-only yes
  529. # Replication SYNC strategy: disk or socket.
  530. #
  531. # New replicas and reconnecting replicas that are not able to continue the
  532. # replication process just receiving differences, need to do what is called a
  533. # "full synchronization". An RDB file is transmitted from the master to the
  534. # replicas.
  535. #
  536. # The transmission can happen in two different ways:
  537. #
  538. # 1) Disk-backed: The Redis master creates a new process that writes the RDB
  539. #                 file on disk. Later the file is transferred by the parent
  540. #                 process to the replicas incrementally.
  541. # 2) Diskless: The Redis master creates a new process that directly writes the
  542. #              RDB file to replica sockets, without touching the disk at all.
  543. #
  544. # With disk-backed replication, while the RDB file is generated, more replicas
  545. # can be queued and served with the RDB file as soon as the current child
  546. # producing the RDB file finishes its work. With diskless replication instead
  547. # once the transfer starts, new replicas arriving will be queued and a new
  548. # transfer will start when the current one terminates.
  549. #
  550. # When diskless replication is used, the master waits a configurable amount of
  551. # time (in seconds) before starting the transfer in the hope that multiple
  552. # replicas will arrive and the transfer can be parallelized.
  553. #
  554. # With slow disks and fast (large bandwidth) networks, diskless replication
  555. # works better.
  556. repl-diskless-sync no
  558. # When diskless replication is enabled, it is possible to configure the delay
  559. # the server waits in order to spawn the child that transfers the RDB via socket
  560. # to the replicas.
  561. #
  562. # This is important since once the transfer starts, it is not possible to serve
  563. # new replicas arriving, that will be queued for the next RDB transfer, so the
  564. # server waits a delay in order to let more replicas arrive.
  565. #
  566. # The delay is specified in seconds, and by default is 5 seconds. To disable
  567. # it entirely just set it to 0 seconds and the transfer will start ASAP.
  568. repl-diskless-sync-delay 5
  570. # -----------------------------------------------------------------------------
  571. # WARNING: RDB diskless load is experimental. Since in this setup the replica
  572. # does not immediately store an RDB on disk, it may cause data loss during
  573. # failovers. RDB diskless load + Redis modules not handling I/O reads may also
  574. # cause Redis to abort in case of I/O errors during the initial synchronization
  575. # stage with the master. Use only if you know what you are doing.
  576. # -----------------------------------------------------------------------------
  577. #
  578. # Replica can load the RDB it reads from the replication link directly from the
  579. # socket, or store the RDB to a file and read that file after it was completely
  580. # received from the master.
  581. #
  582. # In many cases the disk is slower than the network, and storing and loading
  583. # the RDB file may increase replication time (and even increase the master's
  584. # Copy on Write memory and salve buffers).
  585. # However, parsing the RDB file directly from the socket may mean that we have
  586. # to flush the contents of the current database before the full rdb was
  587. # received. For this reason we have the following options:
  588. #
  589. # "disabled"    - Don't use diskless load (store the rdb file to the disk first)
  590. # "on-empty-db" - Use diskless load only when it is completely safe.
  591. # "swapdb"      - Keep a copy of the current db contents in RAM while parsing
  592. #                 the data directly from the socket. note that this requires
  593. #                 sufficient memory, if you don't have it, you risk an OOM kill.
  594. repl-diskless-load disabled
  596. # Replicas send PINGs to server in a predefined interval. It's possible to
  597. # change this interval with the repl_ping_replica_period option. The default
  598. # value is 10 seconds.
  599. #
  600. # repl-ping-replica-period 10
  602. # The following option sets the replication timeout for:
  603. #
  604. # 1) Bulk transfer I/O during SYNC, from the point of view of replica.
  605. # 2) Master timeout from the point of view of replicas (data, pings).
  606. # 3) Replica timeout from the point of view of masters (REPLCONF ACK pings).
  607. #
  608. # It is important to make sure that this value is greater than the value
  609. # specified for repl-ping-replica-period otherwise a timeout will be detected
  610. # every time there is low traffic between the master and the replica. The default
  611. # value is 60 seconds.
  612. #
  613. # repl-timeout 60
  615. # Disable TCP_NODELAY on the replica socket after SYNC?
  616. #
  617. # If you select "yes" Redis will use a smaller number of TCP packets and
  618. # less bandwidth to send data to replicas. But this can add a delay for
  619. # the data to appear on the replica side, up to 40 milliseconds with
  620. # Linux kernels using a default configuration.
  621. #
  622. # If you select "no" the delay for data to appear on the replica side will
  623. # be reduced but more bandwidth will be used for replication.
  624. #
  625. # By default we optimize for low latency, but in very high traffic conditions
  626. # or when the master and replicas are many hops away, turning this to "yes" may
  627. # be a good idea.
  628. repl-disable-tcp-nodelay no
  630. # Set the replication backlog size. The backlog is a buffer that accumulates
  631. # replica data when replicas are disconnected for some time, so that when a
  632. # replica wants to reconnect again, often a full resync is not needed, but a
  633. # partial resync is enough, just passing the portion of data the replica
  634. # missed while disconnected.
  635. #
  636. # The bigger the replication backlog, the longer the replica can endure the
  637. # disconnect and later be able to perform a partial resynchronization.
  638. #
  639. # The backlog is only allocated if there is at least one replica connected.
  640. #
  641. # repl-backlog-size 1mb
  643. # After a master has no connected replicas for some time, the backlog will be
  644. # freed. The following option configures the amount of seconds that need to
  645. # elapse, starting from the time the last replica disconnected, for the backlog
  646. # buffer to be freed.
  647. #
  648. # Note that replicas never free the backlog for timeout, since they may be
  649. # promoted to masters later, and should be able to correctly "partially
  650. # resynchronize" with other replicas: hence they should always accumulate backlog.
  651. #
  652. # A value of 0 means to never release the backlog.
  653. #
  654. # repl-backlog-ttl 3600
  656. # The replica priority is an integer number published by Redis in the INFO
  657. # output. It is used by Redis Sentinel in order to select a replica to promote
  658. # into a master if the master is no longer working correctly.
  659. #
  660. # A replica with a low priority number is considered better for promotion, so
  661. # for instance if there are three replicas with priority 10, 100, 25 Sentinel
  662. # will pick the one with priority 10, that is the lowest.
  663. #
  664. # However a special priority of 0 marks the replica as not able to perform the
  665. # role of master, so a replica with priority of 0 will never be selected by
  666. # Redis Sentinel for promotion.
  667. #
  668. # By default the priority is 100.
  669. replica-priority 100
  671. # -----------------------------------------------------------------------------
  672. # By default, Redis Sentinel includes all replicas in its reports. A replica
  673. # can be excluded from Redis Sentinel's announcements. An unannounced replica
  674. # will be ignored by the 'sentinel replicas <master>' command and won't be
  675. # exposed to Redis Sentinel's clients.
  676. #
  677. # This option does not change the behavior of replica-priority. Even with
  678. # replica-announced set to 'no', the replica can be promoted to master. To
  679. # prevent this behavior, set replica-priority to 0.
  680. #
  681. # replica-announced yes
  683. # It is possible for a master to stop accepting writes if there are less than
  684. # N replicas connected, having a lag less or equal than M seconds.
  685. #
  686. # The N replicas need to be in "online" state.
  687. #
  688. # The lag in seconds, that must be <= the specified value, is calculated from
  689. # the last ping received from the replica, that is usually sent every second.
  690. #
  691. # This option does not GUARANTEE that N replicas will accept the write, but
  692. # will limit the window of exposure for lost writes in case not enough replicas
  693. # are available, to the specified number of seconds.
  694. #
  695. # For example to require at least 3 replicas with a lag <= 10 seconds use:
  696. #
  697. # min-replicas-to-write 3
  698. # min-replicas-max-lag 10
  699. #
  700. # Setting one or the other to 0 disables the feature.
  701. #
  702. # By default min-replicas-to-write is set to 0 (feature disabled) and
  703. # min-replicas-max-lag is set to 10.
  705. # A Redis master is able to list the address and port of the attached
  706. # replicas in different ways. For example the "INFO replication" section
  707. # offers this information, which is used, among other tools, by
  708. # Redis Sentinel in order to discover replica instances.
  709. # Another place where this info is available is in the output of the
  710. # "ROLE" command of a master.
  711. #
  712. # The listed IP address and port normally reported by a replica is
  713. # obtained in the following way:
  714. #
  715. #   IP: The address is auto detected by checking the peer address
  716. #   of the socket used by the replica to connect with the master.
  717. #
  718. #   Port: The port is communicated by the replica during the replication
  719. #   handshake, and is normally the port that the replica is using to
  720. #   listen for connections.
  721. #
  722. # However when port forwarding or Network Address Translation (NAT) is
  723. # used, the replica may actually be reachable via different IP and port
  724. # pairs. The following two options can be used by a replica in order to
  725. # report to its master a specific set of IP and port, so that both INFO
  726. # and ROLE will report those values.
  727. #
  728. # There is no need to use both the options if you need to override just
  729. # the port or the IP address.
  730. #
  731. # replica-announce-ip 5.5.5.5
  732. # replica-announce-port 1234
  734. ############################### KEYS TRACKING #################################
  736. # Redis implements server assisted support for client side caching of values.
  737. # This is implemented using an invalidation table that remembers, using
  738. # a radix key indexed by key name, what clients have which keys. In turn
  739. # this is used in order to send invalidation messages to clients. Please
  740. # check this page to understand more about the feature:
  741. #
  742. #   https://redis.io/topics/client-side-caching
  743. #
  744. # When tracking is enabled for a client, all the read only queries are assumed
  745. # to be cached: this will force Redis to store information in the invalidation
  746. # table. When keys are modified, such information is flushed away, and
  747. # invalidation messages are sent to the clients. However if the workload is
  748. # heavily dominated by reads, Redis could use more and more memory in order
  749. # to track the keys fetched by many clients.
  750. #
  751. # For this reason it is possible to configure a maximum fill value for the
  752. # invalidation table. By default it is set to 1M of keys, and once this limit
  753. # is reached, Redis will start to evict keys in the invalidation table
  754. # even if they were not modified, just to reclaim memory: this will in turn
  755. # force the clients to invalidate the cached values. Basically the table
  756. # maximum size is a trade off between the memory you want to spend server
  757. # side to track information about who cached what, and the ability of clients
  758. # to retain cached objects in memory.
  759. #
  760. # If you set the value to 0, it means there are no limits, and Redis will
  761. # retain as many keys as needed in the invalidation table.
  762. # In the "stats" INFO section, you can find information about the number of
  763. # keys in the invalidation table at every given moment.
  764. #
  765. # Note: when key tracking is used in broadcasting mode, no memory is used
  766. # in the server side so this setting is useless.
  767. #
  768. # tracking-table-max-keys 1000000
  770. ################################## SECURITY ###################################
  772. # Warning: since Redis is pretty fast, an outside user can try up to
  773. # 1 million passwords per second against a modern box. This means that you
  774. # should use very strong passwords, otherwise they will be very easy to break.
  775. # Note that because the password is really a shared secret between the client
  776. # and the server, and should not be memorized by any human, the password
  777. # can be easily a long string from /dev/urandom or whatever, so by using a
  778. # long and unguessable password no brute force attack will be possible.
  780. # Redis ACL users are defined in the following format:
  781. #
  782. #   user <username> ... acl rules ...
  783. #
  784. # For example:
  785. #
  786. #   user worker +@list +@connection ~jobs:* on >ffa9203c493aa99
  787. #
  788. # The special username "default" is used for new connections. If this user
  789. # has the "nopass" rule, then new connections will be immediately authenticated
  790. # as the "default" user without the need of any password provided via the
  791. # AUTH command. Otherwise if the "default" user is not flagged with "nopass"
  792. # the connections will start in not authenticated state, and will require
  793. # AUTH (or the HELLO command AUTH option) in order to be authenticated and
  794. # start to work.
  795. #
  796. # The ACL rules that describe what a user can do are the following:
  797. #
  798. #  on           Enable the user: it is possible to authenticate as this user.
  799. #  off          Disable the user: it's no longer possible to authenticate
  800. #               with this user, however the already authenticated connections
  801. #               will still work.
  802. #  skip-sanitize-payload    RESTORE dump-payload sanitation is skipped.
  803. #  sanitize-payload         RESTORE dump-payload is sanitized (default).
  804. #  +<command>   Allow the execution of that command
  805. #  -<command>   Disallow the execution of that command
  806. #  +@<category> Allow the execution of all the commands in such category
  807. #               with valid categories are like @admin, @set, @sortedset, ...
  808. #               and so forth, see the full list in the server.c file where
  809. #               the Redis command table is described and defined.
  810. #               The special category @all means all the commands, but currently
  811. #               present in the server, and that will be loaded in the future
  812. #               via modules.
  813. #  +<command>|subcommand    Allow a specific subcommand of an otherwise
  814. #                           disabled command. Note that this form is not
  815. #                           allowed as negative like -DEBUG|SEGFAULT, but
  816. #                           only additive starting with "+".
  817. #  allcommands  Alias for +@all. Note that it implies the ability to execute
  818. #               all the future commands loaded via the modules system.
  819. #  nocommands   Alias for -@all.
  820. #  ~<pattern>   Add a pattern of keys that can be mentioned as part of
  821. #               commands. For instance ~* allows all the keys. The pattern
  822. #               is a glob-style pattern like the one of KEYS.
  823. #               It is possible to specify multiple patterns.
  824. #  allkeys      Alias for ~*
  825. #  resetkeys    Flush the list of allowed keys patterns.
  826. #  &<pattern>   Add a glob-style pattern of Pub/Sub channels that can be
  827. #               accessed by the user. It is possible to specify multiple channel
  828. #               patterns.
  829. #  allchannels  Alias for &*
  830. #  resetchannels            Flush the list of allowed channel patterns.
  831. #  ><password>  Add this password to the list of valid password for the user.
  832. #               For example >mypass will add "mypass" to the list.
  833. #               This directive clears the "nopass" flag (see later).
  834. #  <<password>  Remove this password from the list of valid passwords.
  835. #  nopass       All the set passwords of the user are removed, and the user
  836. #               is flagged as requiring no password: it means that every
  837. #               password will work against this user. If this directive is
  838. #               used for the default user, every new connection will be
  839. #               immediately authenticated with the default user without
  840. #               any explicit AUTH command required. Note that the "resetpass"
  841. #               directive will clear this condition.
  842. #  resetpass    Flush the list of allowed passwords. Moreover removes the
  843. #               "nopass" status. After "resetpass" the user has no associated
  844. #               passwords and there is no way to authenticate without adding
  845. #               some password (or setting it as "nopass" later).
  846. #  reset        Performs the following actions: resetpass, resetkeys, off,
  847. #               -@all. The user returns to the same state it has immediately
  848. #               after its creation.
  849. #
  850. # ACL rules can be specified in any order: for instance you can start with
  851. # passwords, then flags, or key patterns. However note that the additive
  852. # and subtractive rules will CHANGE MEANING depending on the ordering.
  853. # For instance see the following example:
  854. #
  855. #   user alice on +@all -DEBUG ~* >somepassword
  856. #
  857. # This will allow "alice" to use all the commands with the exception of the
  858. # DEBUG command, since +@all added all the commands to the set of the commands
  859. # alice can use, and later DEBUG was removed. However if we invert the order
  860. # of two ACL rules the result will be different:
  861. #
  862. #   user alice on -DEBUG +@all ~* >somepassword
  863. #
  864. # Now DEBUG was removed when alice had yet no commands in the set of allowed
  865. # commands, later all the commands are added, so the user will be able to
  866. # execute everything.
  867. #
  868. # Basically ACL rules are processed left-to-right.
  869. #
  870. # For more information about ACL configuration please refer to
  871. # the Redis web site at https://redis.io/topics/acl
  873. # ACL LOG
  874. #
  875. # The ACL Log tracks failed commands and authentication events associated
  876. # with ACLs. The ACL Log is useful to troubleshoot failed commands blocked 
  877. # by ACLs. The ACL Log is stored in memory. You can reclaim memory with 
  878. # ACL LOG RESET. Define the maximum entry length of the ACL Log below.
  879. acllog-max-len 128
  881. # Using an external ACL file
  882. #
  883. # Instead of configuring users here in this file, it is possible to use
  884. # a stand-alone file just listing users. The two methods cannot be mixed:
  885. # if you configure users here and at the same time you activate the external
  886. # ACL file, the server will refuse to start.
  887. #
  888. # The format of the external ACL user file is exactly the same as the
  889. # format that is used inside redis.conf to describe users.
  890. #
  891. # aclfile /etc/redis/users.acl
  893. # IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility
  894. # layer on top of the new ACL system. The option effect will be just setting
  895. # the password for the default user. Clients will still authenticate using
  896. # AUTH <password> as usually, or more explicitly with AUTH default <password>
  897. # if they follow the new protocol: both will work.
  898. #
  899. # The requirepass is not compatable with aclfile option and the ACL LOAD
  900. # command, these will cause requirepass to be ignored.
  901. #
  902. # requirepass foobared
  904. # New users are initialized with restrictive permissions by default, via the
  905. # equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it
  906. # is possible to manage access to Pub/Sub channels with ACL rules as well. The
  907. # default Pub/Sub channels permission if new users is controlled by the 
  908. # acl-pubsub-default configuration directive, which accepts one of these values:
  909. #
  910. # allchannels: grants access to all Pub/Sub channels
  911. # resetchannels: revokes access to all Pub/Sub channels
  912. #
  913. # To ensure backward compatibility while upgrading Redis 6.0, acl-pubsub-default
  914. # defaults to the 'allchannels' permission.
  915. #
  916. # Future compatibility note: it is very likely that in a future version of Redis
  917. # the directive's default of 'allchannels' will be changed to 'resetchannels' in
  918. # order to provide better out-of-the-box Pub/Sub security. Therefore, it is
  919. # recommended that you explicitly define Pub/Sub permissions for all users
  920. # rather then rely on implicit default values. Once you've set explicit
  921. # Pub/Sub for all existing users, you should uncomment the following line.
  922. #
  923. # acl-pubsub-default resetchannels
  925. # Command renaming (DEPRECATED).
  926. #
  927. # ------------------------------------------------------------------------
  928. # WARNING: avoid using this option if possible. Instead use ACLs to remove
  929. # commands from the default user, and put them only in some admin user you
  930. # create for administrative purposes.
  931. # ------------------------------------------------------------------------
  932. #
  933. # It is possible to change the name of dangerous commands in a shared
  934. # environment. For instance the CONFIG command may be renamed into something
  935. # hard to guess so that it will still be available for internal-use tools
  936. # but not available for general clients.
  937. #
  938. # Example:
  939. #
  940. # rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52
  941. #
  942. # It is also possible to completely kill a command by renaming it into
  943. # an empty string:
  944. #
  945. # rename-command CONFIG ""
  946. #
  947. # Please note that changing the name of commands that are logged into the
  948. # AOF file or transmitted to replicas may cause problems.
  950. ################################### CLIENTS ####################################
  952. # Set the max number of connected clients at the same time. By default
  953. # this limit is set to 10000 clients, however if the Redis server is not
  954. # able to configure the process file limit to allow for the specified limit
  955. # the max number of allowed clients is set to the current file limit
  956. # minus 32 (as Redis reserves a few file descriptors for internal uses).
  957. #
  958. # Once the limit is reached Redis will close all the new connections sending
  959. # an error 'max number of clients reached'.
  960. #
  961. # IMPORTANT: When Redis Cluster is used, the max number of connections is also
  962. # shared with the cluster bus: every node in the cluster will use two
  963. # connections, one incoming and another outgoing. It is important to size the
  964. # limit accordingly in case of very large clusters.
  965. #
  966. # maxclients 10000
  968. ############################## MEMORY MANAGEMENT ################################
  970. # Set a memory usage limit to the specified amount of bytes.
  971. # When the memory limit is reached Redis will try to remove keys
  972. # according to the eviction policy selected (see maxmemory-policy).
  973. #
  974. # If Redis can't remove keys according to the policy, or if the policy is
  975. # set to 'noeviction', Redis will start to reply with errors to commands
  976. # that would use more memory, like SET, LPUSH, and so on, and will continue
  977. # to reply to read-only commands like GET.
  978. #
  979. # This option is usually useful when using Redis as an LRU or LFU cache, or to
  980. # set a hard memory limit for an instance (using the 'noeviction' policy).
  981. #
  982. # WARNING: If you have replicas attached to an instance with maxmemory on,
  983. # the size of the output buffers needed to feed the replicas are subtracted
  984. # from the used memory count, so that network problems / resyncs will
  985. # not trigger a loop where keys are evicted, and in turn the output
  986. # buffer of replicas is full with DELs of keys evicted triggering the deletion
  987. # of more keys, and so forth until the database is completely emptied.
  988. #
  989. # In short... if you have replicas attached it is suggested that you set a lower
  990. # limit for maxmemory so that there is some free RAM on the system for replica
  991. # output buffers (but this is not needed if the policy is 'noeviction').
  992. #
  993. # maxmemory <bytes>
  995. # MAXMEMORY POLICY: how Redis will select what to remove when maxmemory
  996. # is reached. You can select one from the following behaviors:
  997. #
  998. # volatile-lru -> Evict using approximated LRU, only keys with an expire set.
  999. # allkeys-lru -> Evict any key using approximated LRU.
  1000. # volatile-lfu -> Evict using approximated LFU, only keys with an expire set.
  1001. # allkeys-lfu -> Evict any key using approximated LFU.
  1002. # volatile-random -> Remove a random key having an expire set.
  1003. # allkeys-random -> Remove a random key, any key.
  1004. # volatile-ttl -> Remove the key with the nearest expire time (minor TTL)
  1005. # noeviction -> Don't evict anything, just return an error on write operations.
  1006. #
  1007. # LRU means Least Recently Used
  1008. # LFU means Least Frequently Used
  1009. #
  1010. # Both LRU, LFU and volatile-ttl are implemented using approximated
  1011. # randomized algorithms.
  1012. #
  1013. # Note: with any of the above policies, when there are no suitable keys for
  1014. # eviction, Redis will return an error on write operations that require
  1015. # more memory. These are usually commands that create new keys, add data or
  1016. # modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE,
  1017. # SORT (due to the STORE argument), and EXEC (if the transaction includes any
  1018. # command that requires memory).
  1019. #
  1020. # The default is:
  1021. #
  1022. # maxmemory-policy noeviction
  1024. # LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated
  1025. # algorithms (in order to save memory), so you can tune it for speed or
  1026. # accuracy. By default Redis will check five keys and pick the one that was
  1027. # used least recently, you can change the sample size using the following
  1028. # configuration directive.
  1029. #
  1030. # The default of 5 produces good enough results. 10 Approximates very closely
  1031. # true LRU but costs more CPU. 3 is faster but not very accurate.
  1032. #
  1033. # maxmemory-samples 5
  1035. # Eviction processing is designed to function well with the default setting.
  1036. # If there is an unusually large amount of write traffic, this value may need to
  1037. # be increased.  Decreasing this value may reduce latency at the risk of 
  1038. # eviction processing effectiveness
  1039. #   0 = minimum latency, 10 = default, 100 = process without regard to latency
  1040. #
  1041. # maxmemory-eviction-tenacity 10
  1043. # Starting from Redis 5, by default a replica will ignore its maxmemory setting
  1044. # (unless it is promoted to master after a failover or manually). It means
  1045. # that the eviction of keys will be just handled by the master, sending the
  1046. # DEL commands to the replica as keys evict in the master side.
  1047. #
  1048. # This behavior ensures that masters and replicas stay consistent, and is usually
  1049. # what you want, however if your replica is writable, or you want the replica
  1050. # to have a different memory setting, and you are sure all the writes performed
  1051. # to the replica are idempotent, then you may change this default (but be sure
  1052. # to understand what you are doing).
  1053. #
  1054. # Note that since the replica by default does not evict, it may end using more
  1055. # memory than the one set via maxmemory (there are certain buffers that may
  1056. # be larger on the replica, or data structures may sometimes take more memory
  1057. # and so forth). So make sure you monitor your replicas and make sure they
  1058. # have enough memory to never hit a real out-of-memory condition before the
  1059. # master hits the configured maxmemory setting.
  1060. #
  1061. # replica-ignore-maxmemory yes
  1063. # Redis reclaims expired keys in two ways: upon access when those keys are
  1064. # found to be expired, and also in background, in what is called the
  1065. # "active expire key". The key space is slowly and interactively scanned
  1066. # looking for expired keys to reclaim, so that it is possible to free memory
  1067. # of keys that are expired and will never be accessed again in a short time.
  1068. #
  1069. # The default effort of the expire cycle will try to avoid having more than
  1070. # ten percent of expired keys still in memory, and will try to avoid consuming
  1071. # more than 25% of total memory and to add latency to the system. However
  1072. # it is possible to increase the expire "effort" that is normally set to
  1073. # "1", to a greater value, up to the value "10". At its maximum value the
  1074. # system will use more CPU, longer cycles (and technically may introduce
  1075. # more latency), and will tolerate less already expired keys still present
  1076. # in the system. It's a tradeoff between memory, CPU and latency.
  1077. #
  1078. # active-expire-effort 1
  1080. ############################# LAZY FREEING ####################################
  1082. # Redis has two primitives to delete keys. One is called DEL and is a blocking
  1083. # deletion of the object. It means that the server stops processing new commands
  1084. # in order to reclaim all the memory associated with an object in a synchronous
  1085. # way. If the key deleted is associated with a small object, the time needed
  1086. # in order to execute the DEL command is very small and comparable to most other
  1087. # O(1) or O(log_N) commands in Redis. However if the key is associated with an
  1088. # aggregated value containing millions of elements, the server can block for
  1089. # a long time (even seconds) in order to complete the operation.
  1090. #
  1091. # For the above reasons Redis also offers non blocking deletion primitives
  1092. # such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and
  1093. # FLUSHDB commands, in order to reclaim memory in background. Those commands
  1094. # are executed in constant time. Another thread will incrementally free the
  1095. # object in the background as fast as possible.
  1096. #
  1097. # DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled.
  1098. # It's up to the design of the application to understand when it is a good
  1099. # idea to use one or the other. However the Redis server sometimes has to
  1100. # delete keys or flush the whole database as a side effect of other operations.
  1101. # Specifically Redis deletes objects independently of a user call in the
  1102. # following scenarios:
  1103. #
  1104. # 1) On eviction, because of the maxmemory and maxmemory policy configurations,
  1105. #    in order to make room for new data, without going over the specified
  1106. #    memory limit.
  1107. # 2) Because of expire: when a key with an associated time to live (see the
  1108. #    EXPIRE command) must be deleted from memory.
  1109. # 3) Because of a side effect of a command that stores data on a key that may
  1110. #    already exist. For example the RENAME command may delete the old key
  1111. #    content when it is replaced with another one. Similarly SUNIONSTORE
  1112. #    or SORT with STORE option may delete existing keys. The SET command
  1113. #    itself removes any old content of the specified key in order to replace
  1114. #    it with the specified string.
  1115. # 4) During replication, when a replica performs a full resynchronization with
  1116. #    its master, the content of the whole database is removed in order to
  1117. #    load the RDB file just transferred.
  1118. #
  1119. # In all the above cases the default is to delete objects in a blocking way,
  1120. # like if DEL was called. However you can configure each case specifically
  1121. # in order to instead release memory in a non-blocking way like if UNLINK
  1122. # was called, using the following configuration directives.
  1124. lazyfree-lazy-eviction no
  1125. lazyfree-lazy-expire no
  1126. lazyfree-lazy-server-del no
  1127. replica-lazy-flush no
  1129. # It is also possible, for the case when to replace the user code DEL calls
  1130. # with UNLINK calls is not easy, to modify the default behavior of the DEL
  1131. # command to act exactly like UNLINK, using the following configuration
  1132. # directive:
  1134. lazyfree-lazy-user-del no
  1136. # FLUSHDB, FLUSHALL, and SCRIPT FLUSH support both asynchronous and synchronous
  1137. # deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the
  1138. # commands. When neither flag is passed, this directive will be used to determine
  1139. # if the data should be deleted asynchronously.
  1141. lazyfree-lazy-user-flush no
  1143. ################################ THREADED I/O #################################
  1145. # Redis is mostly single threaded, however there are certain threaded
  1146. # operations such as UNLINK, slow I/O accesses and other things that are
  1147. # performed on side threads.
  1148. #
  1149. # Now it is also possible to handle Redis clients socket reads and writes
  1150. # in different I/O threads. Since especially writing is so slow, normally
  1151. # Redis users use pipelining in order to speed up the Redis performances per
  1152. # core, and spawn multiple instances in order to scale more. Using I/O
  1153. # threads it is possible to easily speedup two times Redis without resorting
  1154. # to pipelining nor sharding of the instance.
  1155. #
  1156. # By default threading is disabled, we suggest enabling it only in machines
  1157. # that have at least 4 or more cores, leaving at least one spare core.
  1158. # Using more than 8 threads is unlikely to help much. We also recommend using
  1159. # threaded I/O only if you actually have performance problems, with Redis
  1160. # instances being able to use a quite big percentage of CPU time, otherwise
  1161. # there is no point in using this feature.
  1162. #
  1163. # So for instance if you have a four cores boxes, try to use 2 or 3 I/O
  1164. # threads, if you have a 8 cores, try to use 6 threads. In order to
  1165. # enable I/O threads use the following configuration directive:
  1166. #
  1167. # io-threads 4
  1168. #
  1169. # Setting io-threads to 1 will just use the main thread as usual.
  1170. # When I/O threads are enabled, we only use threads for writes, that is
  1171. # to thread the write(2) syscall and transfer the client buffers to the
  1172. # socket. However it is also possible to enable threading of reads and
  1173. # protocol parsing using the following configuration directive, by setting
  1174. # it to yes:
  1175. #
  1176. # io-threads-do-reads no
  1177. #
  1178. # Usually threading reads doesn't help much.
  1179. #
  1180. # NOTE 1: This configuration directive cannot be changed at runtime via
  1181. # CONFIG SET. Aso this feature currently does not work when SSL is
  1182. # enabled.
  1183. #
  1184. # NOTE 2: If you want to test the Redis speedup using redis-benchmark, make
  1185. # sure you also run the benchmark itself in threaded mode, using the
  1186. # --threads option to match the number of Redis threads, otherwise you'll not
  1187. # be able to notice the improvements.
  1189. ############################ KERNEL OOM CONTROL ##############################
  1191. # On Linux, it is possible to hint the kernel OOM killer on what processes
  1192. # should be killed first when out of memory.
  1193. #
  1194. # Enabling this feature makes Redis actively control the oom_score_adj value
  1195. # for all its processes, depending on their role. The default scores will
  1196. # attempt to have background child processes killed before all others, and
  1197. # replicas killed before masters.
  1198. #
  1199. # Redis supports three options:
  1200. #
  1201. # no:       Don't make changes to oom-score-adj (default).
  1202. # yes:      Alias to "relative" see below.
  1203. # absolute: Values in oom-score-adj-values are written as is to the kernel.
  1204. # relative: Values are used relative to the initial value of oom_score_adj when
  1205. #           the server starts and are then clamped to a range of -1000 to 1000.
  1206. #           Because typically the initial value is 0, they will often match the
  1207. #           absolute values.
  1208. oom-score-adj no
  1210. # When oom-score-adj is used, this directive controls the specific values used
  1211. # for master, replica and background child processes. Values range -2000 to
  1212. # 2000 (higher means more likely to be killed).
  1213. #
  1214. # Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities)
  1215. # can freely increase their value, but not decrease it below its initial
  1216. # settings. This means that setting oom-score-adj to "relative" and setting the
  1217. # oom-score-adj-values to positive values will always succeed.
  1218. oom-score-adj-values 0 200 800
  1221. #################### KERNEL transparent hugepage CONTROL ######################
  1223. # Usually the kernel Transparent Huge Pages control is set to "madvise" or
  1224. # or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which
  1225. # case this config has no effect. On systems in which it is set to "always",
  1226. # redis will attempt to disable it specifically for the redis process in order
  1227. # to avoid latency problems specifically with fork(2) and CoW.
  1228. # If for some reason you prefer to keep it enabled, you can set this config to
  1229. # "no" and the kernel global to "always".
  1231. disable-thp yes
  1233. ############################## APPEND ONLY MODE ###############################
  1235. # By default Redis asynchronously dumps the dataset on disk. This mode is
  1236. # good enough in many applications, but an issue with the Redis process or
  1237. # a power outage may result into a few minutes of writes lost (depending on
  1238. # the configured save points).
  1239. #
  1240. # The Append Only File is an alternative persistence mode that provides
  1241. # much better durability. For instance using the default data fsync policy
  1242. # (see later in the config file) Redis can lose just one second of writes in a
  1243. # dramatic event like a server power outage, or a single write if something
  1244. # wrong with the Redis process itself happens, but the operating system is
  1245. # still running correctly.
  1246. #
  1247. # AOF and RDB persistence can be enabled at the same time without problems.
  1248. # If the AOF is enabled on startup Redis will load the AOF, that is the file
  1249. # with the better durability guarantees.
  1250. #
  1251. # Please check https://redis.io/topics/persistence for more information.
  1253. appendonly no
  1255. # The name of the append only file (default: "appendonly.aof")
  1257. appendfilename "appendonly.aof"
  1259. # The fsync() call tells the Operating System to actually write data on disk
  1260. # instead of waiting for more data in the output buffer. Some OS will really flush
  1261. # data on disk, some other OS will just try to do it ASAP.
  1262. #
  1263. # Redis supports three different modes:
  1264. #
  1265. # no: don't fsync, just let the OS flush the data when it wants. Faster.
  1266. # always: fsync after every write to the append only log. Slow, Safest.
  1267. # everysec: fsync only one time every second. Compromise.
  1268. #
  1269. # The default is "everysec", as that's usually the right compromise between
  1270. # speed and data safety. It's up to you to understand if you can relax this to
  1271. # "no" that will let the operating system flush the output buffer when
  1272. # it wants, for better performances (but if you can live with the idea of
  1273. # some data loss consider the default persistence mode that's snapshotting),
  1274. # or on the contrary, use "always" that's very slow but a bit safer than
  1275. # everysec.
  1276. #
  1277. # More details please check the following article:
  1278. # http://antirez.com/post/redis-persistence-demystified.html
  1279. #
  1280. # If unsure, use "everysec".
  1282. # appendfsync always
  1283. appendfsync everysec
  1284. # appendfsync no
  1286. # When the AOF fsync policy is set to always or everysec, and a background
  1287. # saving process (a background save or AOF log background rewriting) is
  1288. # performing a lot of I/O against the disk, in some Linux configurations
  1289. # Redis may block too long on the fsync() call. Note that there is no fix for
  1290. # this currently, as even performing fsync in a different thread will block
  1291. # our synchronous write(2) call.
  1292. #
  1293. # In order to mitigate this problem it's possible to use the following option
  1294. # that will prevent fsync() from being called in the main process while a
  1295. # BGSAVE or BGREWRITEAOF is in progress.
  1296. #
  1297. # This means that while another child is saving, the durability of Redis is
  1298. # the same as "appendfsync none". In practical terms, this means that it is
  1299. # possible to lose up to 30 seconds of log in the worst scenario (with the
  1300. # default Linux settings).
  1301. #
  1302. # If you have latency problems turn this to "yes". Otherwise leave it as
  1303. # "no" that is the safest pick from the point of view of durability.
  1305. no-appendfsync-on-rewrite no
  1307. # Automatic rewrite of the append only file.
  1308. # Redis is able to automatically rewrite the log file implicitly calling
  1309. # BGREWRITEAOF when the AOF log size grows by the specified percentage.
  1310. #
  1311. # This is how it works: Redis remembers the size of the AOF file after the
  1312. # latest rewrite (if no rewrite has happened since the restart, the size of
  1313. # the AOF at startup is used).
  1314. #
  1315. # This base size is compared to the current size. If the current size is
  1316. # bigger than the specified percentage, the rewrite is triggered. Also
  1317. # you need to specify a minimal size for the AOF file to be rewritten, this
  1318. # is useful to avoid rewriting the AOF file even if the percentage increase
  1319. # is reached but it is still pretty small.
  1320. #
  1321. # Specify a percentage of zero in order to disable the automatic AOF
  1322. # rewrite feature.
  1324. auto-aof-rewrite-percentage 100
  1325. auto-aof-rewrite-min-size 64mb
  1327. # An AOF file may be found to be truncated at the end during the Redis
  1328. # startup process, when the AOF data gets loaded back into memory.
  1329. # This may happen when the system where Redis is running
  1330. # crashes, especially when an ext4 filesystem is mounted without the
  1331. # data=ordered option (however this can't happen when Redis itself
  1332. # crashes or aborts but the operating system still works correctly).
  1333. #
  1334. # Redis can either exit with an error when this happens, or load as much
  1335. # data as possible (the default now) and start if the AOF file is found
  1336. # to be truncated at the end. The following option controls this behavior.
  1337. #
  1338. # If aof-load-truncated is set to yes, a truncated AOF file is loaded and
  1339. # the Redis server starts emitting a log to inform the user of the event.
  1340. # Otherwise if the option is set to no, the server aborts with an error
  1341. # and refuses to start. When the option is set to no, the user requires
  1342. # to fix the AOF file using the "redis-check-aof" utility before to restart
  1343. # the server.
  1344. #
  1345. # Note that if the AOF file will be found to be corrupted in the middle
  1346. # the server will still exit with an error. This option only applies when
  1347. # Redis will try to read more data from the AOF file but not enough bytes
  1348. # will be found.
  1349. aof-load-truncated yes
  1351. # When rewriting the AOF file, Redis is able to use an RDB preamble in the
  1352. # AOF file for faster rewrites and recoveries. When this option is turned
  1353. # on the rewritten AOF file is composed of two different stanzas:
  1354. #
  1355. #   [RDB file][AOF tail]
  1356. #
  1357. # When loading, Redis recognizes that the AOF file starts with the "REDIS"
  1358. # string and loads the prefixed RDB file, then continues loading the AOF
  1359. # tail.
  1360. aof-use-rdb-preamble yes
  1362. ################################ LUA SCRIPTING  ###############################
  1364. # Max execution time of a Lua script in milliseconds.
  1365. #
  1366. # If the maximum execution time is reached Redis will log that a script is
  1367. # still in execution after the maximum allowed time and will start to
  1368. # reply to queries with an error.
  1369. #
  1370. # When a long running script exceeds the maximum execution time only the
  1371. # SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be
  1372. # used to stop a script that did not yet call any write commands. The second
  1373. # is the only way to shut down the server in the case a write command was
  1374. # already issued by the script but the user doesn't want to wait for the natural
  1375. # termination of the script.
  1376. #
  1377. # Set it to 0 or a negative value for unlimited execution without warnings.
  1378. lua-time-limit 5000
  1380. ################################ REDIS CLUSTER  ###############################
  1382. # Normal Redis instances can't be part of a Redis Cluster; only nodes that are
  1383. # started as cluster nodes can. In order to start a Redis instance as a
  1384. # cluster node enable the cluster support uncommenting the following:
  1385. #
  1386. # cluster-enabled yes
  1388. # Every cluster node has a cluster configuration file. This file is not
  1389. # intended to be edited by hand. It is created and updated by Redis nodes.
  1390. # Every Redis Cluster node requires a different cluster configuration file.
  1391. # Make sure that instances running in the same system do not have
  1392. # overlapping cluster configuration file names.
  1393. #
  1394. # cluster-config-file nodes-6379.conf
  1396. # Cluster node timeout is the amount of milliseconds a node must be unreachable
  1397. # for it to be considered in failure state.
  1398. # Most other internal time limits are a multiple of the node timeout.
  1399. #
  1400. # cluster-node-timeout 15000
  1402. # A replica of a failing master will avoid to start a failover if its data
  1403. # looks too old.
  1404. #
  1405. # There is no simple way for a replica to actually have an exact measure of
  1406. # its "data age", so the following two checks are performed:
  1407. #
  1408. # 1) If there are multiple replicas able to failover, they exchange messages
  1409. #    in order to try to give an advantage to the replica with the best
  1410. #    replication offset (more data from the master processed).
  1411. #    Replicas will try to get their rank by offset, and apply to the start
  1412. #    of the failover a delay proportional to their rank.
  1413. #
  1414. # 2) Every single replica computes the time of the last interaction with
  1415. #    its master. This can be the last ping or command received (if the master
  1416. #    is still in the "connected" state), or the time that elapsed since the
  1417. #    disconnection with the master (if the replication link is currently down).
  1418. #    If the last interaction is too old, the replica will not try to failover
  1419. #    at all.
  1420. #
  1421. # The point "2" can be tuned by user. Specifically a replica will not perform
  1422. # the failover if, since the last interaction with the master, the time
  1423. # elapsed is greater than:
  1424. #
  1425. #   (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period
  1426. #
  1427. # So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor
  1428. # is 10, and assuming a default repl-ping-replica-period of 10 seconds, the
  1429. # replica will not try to failover if it was not able to talk with the master
  1430. # for longer than 310 seconds.
  1431. #
  1432. # A large cluster-replica-validity-factor may allow replicas with too old data to failover
  1433. # a master, while a too small value may prevent the cluster from being able to
  1434. # elect a replica at all.
  1435. #
  1436. # For maximum availability, it is possible to set the cluster-replica-validity-factor
  1437. # to a value of 0, which means, that replicas will always try to failover the
  1438. # master regardless of the last time they interacted with the master.
  1439. # (However they'll always try to apply a delay proportional to their
  1440. # offset rank).
  1441. #
  1442. # Zero is the only value able to guarantee that when all the partitions heal
  1443. # the cluster will always be able to continue.
  1444. #
  1445. # cluster-replica-validity-factor 10
  1447. # Cluster replicas are able to migrate to orphaned masters, that are masters
  1448. # that are left without working replicas. This improves the cluster ability
  1449. # to resist to failures as otherwise an orphaned master can't be failed over
  1450. # in case of failure if it has no working replicas.
  1451. #
  1452. # Replicas migrate to orphaned masters only if there are still at least a
  1453. # given number of other working replicas for their old master. This number
  1454. # is the "migration barrier". A migration barrier of 1 means that a replica
  1455. # will migrate only if there is at least 1 other working replica for its master
  1456. # and so forth. It usually reflects the number of replicas you want for every
  1457. # master in your cluster.
  1458. #
  1459. # Default is 1 (replicas migrate only if their masters remain with at least
  1460. # one replica). To disable migration just set it to a very large value or
  1461. # set cluster-allow-replica-migration to 'no'.
  1462. # A value of 0 can be set but is useful only for debugging and dangerous
  1463. # in production.
  1464. #
  1465. # cluster-migration-barrier 1
  1467. # Turning off this option allows to use less automatic cluster configuration.
  1468. # It both disables migration to orphaned masters and migration from masters
  1469. # that became empty.
  1470. #
  1471. # Default is 'yes' (allow automatic migrations).
  1472. #
  1473. # cluster-allow-replica-migration yes
  1475. # By default Redis Cluster nodes stop accepting queries if they detect there
  1476. # is at least a hash slot uncovered (no available node is serving it).
  1477. # This way if the cluster is partially down (for example a range of hash slots
  1478. # are no longer covered) all the cluster becomes, eventually, unavailable.
  1479. # It automatically returns available as soon as all the slots are covered again.
  1480. #
  1481. # However sometimes you want the subset of the cluster which is working,
  1482. # to continue to accept queries for the part of the key space that is still
  1483. # covered. In order to do so, just set the cluster-require-full-coverage
  1484. # option to no.
  1485. #
  1486. # cluster-require-full-coverage yes
  1488. # This option, when set to yes, prevents replicas from trying to failover its
  1489. # master during master failures. However the replica can still perform a
  1490. # manual failover, if forced to do so.
  1491. #
  1492. # This is useful in different scenarios, especially in the case of multiple
  1493. # data center operations, where we want one side to never be promoted if not
  1494. # in the case of a total DC failure.
  1495. #
  1496. # cluster-replica-no-failover no
  1498. # This option, when set to yes, allows nodes to serve read traffic while the
  1499. # the cluster is in a down state, as long as it believes it owns the slots. 
  1500. #
  1501. # This is useful for two cases.  The first case is for when an application 
  1502. # doesn't require consistency of data during node failures or network partitions.
  1503. # One example of this is a cache, where as long as the node has the data it
  1504. # should be able to serve it. 
  1505. #
  1506. # The second use case is for configurations that don't meet the recommended  
  1507. # three shards but want to enable cluster mode and scale later. A 
  1508. # master outage in a 1 or 2 shard configuration causes a read/write outage to the
  1509. # entire cluster without this option set, with it set there is only a write outage.
  1510. # Without a quorum of masters, slot ownership will not change automatically. 
  1511. #
  1512. # cluster-allow-reads-when-down no
  1514. # In order to setup your cluster make sure to read the documentation
  1515. # available at https://redis.io web site.
  1517. ########################## CLUSTER DOCKER/NAT support  ########################
  1519. # In certain deployments, Redis Cluster nodes address discovery fails, because
  1520. # addresses are NAT-ted or because ports are forwarded (the typical case is
  1521. # Docker and other containers).
  1522. #
  1523. # In order to make Redis Cluster working in such environments, a static
  1524. # configuration where each node knows its public address is needed. The
  1525. # following four options are used for this scope, and are:
  1526. #
  1527. # * cluster-announce-ip
  1528. # * cluster-announce-port
  1529. # * cluster-announce-tls-port
  1530. # * cluster-announce-bus-port
  1531. #
  1532. # Each instructs the node about its address, client ports (for connections
  1533. # without and with TLS) and cluster message bus port. The information is then
  1534. # published in the header of the bus packets so that other nodes will be able to
  1535. # correctly map the address of the node publishing the information.
  1536. #
  1537. # If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set
  1538. # to zero, then cluster-announce-port refers to the TLS port. Note also that
  1539. # cluster-announce-tls-port has no effect if cluster-tls is set to no.
  1540. #
  1541. # If the above options are not used, the normal Redis Cluster auto-detection
  1542. # will be used instead.
  1543. #
  1544. # Note that when remapped, the bus port may not be at the fixed offset of
  1545. # clients port + 10000, so you can specify any port and bus-port depending
  1546. # on how they get remapped. If the bus-port is not set, a fixed offset of
  1547. # 10000 will be used as usual.
  1548. #
  1549. # Example:
  1550. #
  1551. # cluster-announce-ip 10.1.1.5
  1552. # cluster-announce-tls-port 6379
  1553. # cluster-announce-port 0
  1554. # cluster-announce-bus-port 6380
  1556. ################################## SLOW LOG ###################################
  1558. # The Redis Slow Log is a system to log queries that exceeded a specified
  1559. # execution time. The execution time does not include the I/O operations
  1560. # like talking with the client, sending the reply and so forth,
  1561. # but just the time needed to actually execute the command (this is the only
  1562. # stage of command execution where the thread is blocked and can not serve
  1563. # other requests in the meantime).
  1564. #
  1565. # You can configure the slow log with two parameters: one tells Redis
  1566. # what is the execution time, in microseconds, to exceed in order for the
  1567. # command to get logged, and the other parameter is the length of the
  1568. # slow log. When a new command is logged the oldest one is removed from the
  1569. # queue of logged commands.
  1571. # The following time is expressed in microseconds, so 1000000 is equivalent
  1572. # to one second. Note that a negative number disables the slow log, while
  1573. # a value of zero forces the logging of every command.
  1574. slowlog-log-slower-than 10000
  1576. # There is no limit to this length. Just be aware that it will consume memory.
  1577. # You can reclaim memory used by the slow log with SLOWLOG RESET.
  1578. slowlog-max-len 128
  1580. ################################ LATENCY MONITOR ##############################
  1582. # The Redis latency monitoring subsystem samples different operations
  1583. # at runtime in order to collect data related to possible sources of
  1584. # latency of a Redis instance.
  1585. #
  1586. # Via the LATENCY command this information is available to the user that can
  1587. # print graphs and obtain reports.
  1588. #
  1589. # The system only logs operations that were performed in a time equal or
  1590. # greater than the amount of milliseconds specified via the
  1591. # latency-monitor-threshold configuration directive. When its value is set
  1592. # to zero, the latency monitor is turned off.
  1593. #
  1594. # By default latency monitoring is disabled since it is mostly not needed
  1595. # if you don't have latency issues, and collecting data has a performance
  1596. # impact, that while very small, can be measured under big load. Latency
  1597. # monitoring can easily be enabled at runtime using the command
  1598. # "CONFIG SET latency-monitor-threshold <milliseconds>" if needed.
  1599. latency-monitor-threshold 0
  1601. ############################# EVENT NOTIFICATION ##############################
  1603. # Redis can notify Pub/Sub clients about events happening in the key space.
  1604. # This feature is documented at https://redis.io/topics/notifications
  1605. #
  1606. # For instance if keyspace events notification is enabled, and a client
  1607. # performs a DEL operation on key "foo" stored in the Database 0, two
  1608. # messages will be published via Pub/Sub:
  1609. #
  1610. # PUBLISH __keyspace@0__:foo del
  1611. # PUBLISH __keyevent@0__:del foo
  1612. #
  1613. # It is possible to select the events that Redis will notify among a set
  1614. # of classes. Every class is identified by a single character:
  1615. #
  1616. #  K     Keyspace events, published with __keyspace@<db>__ prefix.
  1617. #  E     Keyevent events, published with __keyevent@<db>__ prefix.
  1618. #  g     Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ...
  1619. #  $     String commands
  1620. #  l     List commands
  1621. #  s     Set commands
  1622. #  h     Hash commands
  1623. #  z     Sorted set commands
  1624. #  x     Expired events (events generated every time a key expires)
  1625. #  e     Evicted events (events generated when a key is evicted for maxmemory)
  1626. #  t     Stream commands
  1627. #  d     Module key type events
  1628. #  m     Key-miss events (Note: It is not included in the 'A' class)
  1629. #  A     Alias for g$lshzxetd, so that the "AKE" string means all the events
  1630. #        (Except key-miss events which are excluded from 'A' due to their
  1631. #         unique nature).
  1632. #
  1633. #  The "notify-keyspace-events" takes as argument a string that is composed
  1634. #  of zero or multiple characters. The empty string means that notifications
  1635. #  are disabled.
  1636. #
  1637. #  Example: to enable list and generic events, from the point of view of the
  1638. #           event name, use:
  1639. #
  1640. #  notify-keyspace-events Elg
  1641. #
  1642. #  Example 2: to get the stream of the expired keys subscribing to channel
  1643. #             name __keyevent@0__:expired use:
  1644. #
  1645. #  notify-keyspace-events Ex
  1646. #
  1647. #  By default all notifications are disabled because most users don't need
  1648. #  this feature and the feature has some overhead. Note that if you don't
  1649. #  specify at least one of K or E, no events will be delivered.
  1650. notify-keyspace-events ""
  1652. ############################### GOPHER SERVER #################################
  1654. # Redis contains an implementation of the Gopher protocol, as specified in
  1655. # the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt).
  1656. #
  1657. # The Gopher protocol was very popular in the late '90s. It is an alternative
  1658. # to the web, and the implementation both server and client side is so simple
  1659. # that the Redis server has just 100 lines of code in order to implement this
  1660. # support.
  1661. #
  1662. # What do you do with Gopher nowadays? Well Gopher never *really* died, and
  1663. # lately there is a movement in order for the Gopher more hierarchical content
  1664. # composed of just plain text documents to be resurrected. Some want a simpler
  1665. # internet, others believe that the mainstream internet became too much
  1666. # controlled, and it's cool to create an alternative space for people that
  1667. # want a bit of fresh air.
  1668. #
  1669. # Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol
  1670. # as a gift.
  1671. #
  1672. # --- HOW IT WORKS? ---
  1673. #
  1674. # The Redis Gopher support uses the inline protocol of Redis, and specifically
  1675. # two kind of inline requests that were anyway illegal: an empty request
  1676. # or any request that starts with "/" (there are no Redis commands starting
  1677. # with such a slash). Normal RESP2/RESP3 requests are completely out of the
  1678. # path of the Gopher protocol implementation and are served as usual as well.
  1679. #
  1680. # If you open a connection to Redis when Gopher is enabled and send it
  1681. # a string like "/foo", if there is a key named "/foo" it is served via the
  1682. # Gopher protocol.
  1683. #
  1684. # In order to create a real Gopher "hole" (the name of a Gopher site in Gopher
  1685. # talking), you likely need a script like the following:
  1686. #
  1687. #   https://github.com/antirez/gopher2redis
  1688. #
  1689. # --- SECURITY WARNING ---
  1690. #
  1691. # If you plan to put Redis on the internet in a publicly accessible address
  1692. # to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance.
  1693. # Once a password is set:
  1694. #
  1695. #   1. The Gopher server (when enabled, not by default) will still serve
  1696. #      content via Gopher.
  1697. #   2. However other commands cannot be called before the client will
  1698. #      authenticate.
  1699. #
  1700. # So use the 'requirepass' option to protect your instance.
  1701. #
  1702. # Note that Gopher is not currently supported when 'io-threads-do-reads'
  1703. # is enabled.
  1704. #
  1705. # To enable Gopher support, uncomment the following line and set the option
  1706. # from no (the default) to yes.
  1707. #
  1708. # gopher-enabled no
  1710. ############################### ADVANCED CONFIG ###############################
  1712. # Hashes are encoded using a memory efficient data structure when they have a
  1713. # small number of entries, and the biggest entry does not exceed a given
  1714. # threshold. These thresholds can be configured using the following directives.
  1715. hash-max-ziplist-entries 512
  1716. hash-max-ziplist-value 64
  1718. # Lists are also encoded in a special way to save a lot of space.
  1719. # The number of entries allowed per internal list node can be specified
  1720. # as a fixed maximum size or a maximum number of elements.
  1721. # For a fixed maximum size, use -5 through -1, meaning:
  1722. # -5: max size: 64 Kb  <-- not recommended for normal workloads
  1723. # -4: max size: 32 Kb  <-- not recommended
  1724. # -3: max size: 16 Kb  <-- probably not recommended
  1725. # -2: max size: 8 Kb   <-- good
  1726. # -1: max size: 4 Kb   <-- good
  1727. # Positive numbers mean store up to _exactly_ that number of elements
  1728. # per list node.
  1729. # The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size),
  1730. # but if your use case is unique, adjust the settings as necessary.
  1731. list-max-ziplist-size -2
  1733. # Lists may also be compressed.
  1734. # Compress depth is the number of quicklist ziplist nodes from *each* side of
  1735. # the list to *exclude* from compression.  The head and tail of the list
  1736. # are always uncompressed for fast push/pop operations.  Settings are:
  1737. # 0: disable all list compression
  1738. # 1: depth 1 means "don't start compressing until after 1 node into the list,
  1739. #    going from either the head or tail"
  1740. #    So: [head]->node->node->...->node->[tail]
  1741. #    [head], [tail] will always be uncompressed; inner nodes will compress.
  1742. # 2: [head]->[next]->node->node->...->node->[prev]->[tail]
  1743. #    2 here means: don't compress head or head->next or tail->prev or tail,
  1744. #    but compress all nodes between them.
  1745. # 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail]
  1746. # etc.
  1747. list-compress-depth 0
  1749. # Sets have a special encoding in just one case: when a set is composed
  1750. # of just strings that happen to be integers in radix 10 in the range
  1751. # of 64 bit signed integers.
  1752. # The following configuration setting sets the limit in the size of the
  1753. # set in order to use this special memory saving encoding.
  1754. set-max-intset-entries 512
  1756. # Similarly to hashes and lists, sorted sets are also specially encoded in
  1757. # order to save a lot of space. This encoding is only used when the length and
  1758. # elements of a sorted set are below the following limits:
  1759. zset-max-ziplist-entries 128
  1760. zset-max-ziplist-value 64
  1762. # HyperLogLog sparse representation bytes limit. The limit includes the
  1763. # 16 bytes header. When an HyperLogLog using the sparse representation crosses
  1764. # this limit, it is converted into the dense representation.
  1765. #
  1766. # A value greater than 16000 is totally useless, since at that point the
  1767. # dense representation is more memory efficient.
  1768. #
  1769. # The suggested value is ~ 3000 in order to have the benefits of
  1770. # the space efficient encoding without slowing down too much PFADD,
  1771. # which is O(N) with the sparse encoding. The value can be raised to
  1772. # ~ 10000 when CPU is not a concern, but space is, and the data set is
  1773. # composed of many HyperLogLogs with cardinality in the 0 - 15000 range.
  1774. hll-sparse-max-bytes 3000
  1776. # Streams macro node max size / items. The stream data structure is a radix
  1777. # tree of big nodes that encode multiple items inside. Using this configuration
  1778. # it is possible to configure how big a single node can be in bytes, and the
  1779. # maximum number of items it may contain before switching to a new node when
  1780. # appending new stream entries. If any of the following settings are set to
  1781. # zero, the limit is ignored, so for instance it is possible to set just a
  1782. # max entries limit by setting max-bytes to 0 and max-entries to the desired
  1783. # value.
  1784. stream-node-max-bytes 4096
  1785. stream-node-max-entries 100
  1787. # Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in
  1788. # order to help rehashing the main Redis hash table (the one mapping top-level
  1789. # keys to values). The hash table implementation Redis uses (see dict.c)
  1790. # performs a lazy rehashing: the more operation you run into a hash table
  1791. # that is rehashing, the more rehashing "steps" are performed, so if the
  1792. # server is idle the rehashing is never complete and some more memory is used
  1793. # by the hash table.
  1794. #
  1795. # The default is to use this millisecond 10 times every second in order to
  1796. # actively rehash the main dictionaries, freeing memory when possible.
  1797. #
  1798. # If unsure:
  1799. # use "activerehashing no" if you have hard latency requirements and it is
  1800. # not a good thing in your environment that Redis can reply from time to time
  1801. # to queries with 2 milliseconds delay.
  1802. #
  1803. # use "activerehashing yes" if you don't have such hard requirements but
  1804. # want to free memory asap when possible.
  1805. activerehashing yes
  1807. # The client output buffer limits can be used to force disconnection of clients
  1808. # that are not reading data from the server fast enough for some reason (a
  1809. # common reason is that a Pub/Sub client can't consume messages as fast as the
  1810. # publisher can produce them).
  1811. #
  1812. # The limit can be set differently for the three different classes of clients:
  1813. #
  1814. # normal -> normal clients including MONITOR clients
  1815. # replica  -> replica clients
  1816. # pubsub -> clients subscribed to at least one pubsub channel or pattern
  1817. #
  1818. # The syntax of every client-output-buffer-limit directive is the following:
  1819. #
  1820. # client-output-buffer-limit <class> <hard limit> <soft limit> <soft seconds>
  1821. #
  1822. # A client is immediately disconnected once the hard limit is reached, or if
  1823. # the soft limit is reached and remains reached for the specified number of
  1824. # seconds (continuously).
  1825. # So for instance if the hard limit is 32 megabytes and the soft limit is
  1826. # 16 megabytes / 10 seconds, the client will get disconnected immediately
  1827. # if the size of the output buffers reach 32 megabytes, but will also get
  1828. # disconnected if the client reaches 16 megabytes and continuously overcomes
  1829. # the limit for 10 seconds.
  1830. #
  1831. # By default normal clients are not limited because they don't receive data
  1832. # without asking (in a push way), but just after a request, so only
  1833. # asynchronous clients may create a scenario where data is requested faster
  1834. # than it can read.
  1835. #
  1836. # Instead there is a default limit for pubsub and replica clients, since
  1837. # subscribers and replicas receive data in a push fashion.
  1838. #
  1839. # Both the hard or the soft limit can be disabled by setting them to zero.
  1840. client-output-buffer-limit normal 0 0 0
  1841. client-output-buffer-limit replica 256mb 64mb 60
  1842. client-output-buffer-limit pubsub 32mb 8mb 60
  1844. # Client query buffers accumulate new commands. They are limited to a fixed
  1845. # amount by default in order to avoid that a protocol desynchronization (for
  1846. # instance due to a bug in the client) will lead to unbound memory usage in
  1847. # the query buffer. However you can configure it here if you have very special
  1848. # needs, such us huge multi/exec requests or alike.
  1849. #
  1850. # client-query-buffer-limit 1gb
  1852. # In the Redis protocol, bulk requests, that are, elements representing single
  1853. # strings, are normally limited to 512 mb. However you can change this limit
  1854. # here, but must be 1mb or greater
  1855. #
  1856. # proto-max-bulk-len 512mb
  1858. # Redis calls an internal function to perform many background tasks, like
  1859. # closing connections of clients in timeout, purging expired keys that are
  1860. # never requested, and so forth.
  1861. #
  1862. # Not all tasks are performed with the same frequency, but Redis checks for
  1863. # tasks to perform according to the specified "hz" value.
  1864. #
  1865. # By default "hz" is set to 10. Raising the value will use more CPU when
  1866. # Redis is idle, but at the same time will make Redis more responsive when
  1867. # there are many keys expiring at the same time, and timeouts may be
  1868. # handled with more precision.
  1869. #
  1870. # The range is between 1 and 500, however a value over 100 is usually not
  1871. # a good idea. Most users should use the default of 10 and raise this up to
  1872. # 100 only in environments where very low latency is required.
  1873. hz 10
  1875. # Normally it is useful to have an HZ value which is proportional to the
  1876. # number of clients connected. This is useful in order, for instance, to
  1877. # avoid too many clients are processed for each background task invocation
  1878. # in order to avoid latency spikes.
  1879. #
  1880. # Since the default HZ value by default is conservatively set to 10, Redis
  1881. # offers, and enables by default, the ability to use an adaptive HZ value
  1882. # which will temporarily raise when there are many connected clients.
  1883. #
  1884. # When dynamic HZ is enabled, the actual configured HZ will be used
  1885. # as a baseline, but multiples of the configured HZ value will be actually
  1886. # used as needed once more clients are connected. In this way an idle
  1887. # instance will use very little CPU time while a busy instance will be
  1888. # more responsive.
  1889. dynamic-hz yes
  1891. # When a child rewrites the AOF file, if the following option is enabled
  1892. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1893. # in order to commit the file to the disk more incrementally and avoid
  1894. # big latency spikes.
  1895. aof-rewrite-incremental-fsync yes
  1897. # When redis saves RDB file, if the following option is enabled
  1898. # the file will be fsync-ed every 32 MB of data generated. This is useful
  1899. # in order to commit the file to the disk more incrementally and avoid
  1900. # big latency spikes.
  1901. rdb-save-incremental-fsync yes
  1903. # Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good
  1904. # idea to start with the default settings and only change them after investigating
  1905. # how to improve the performances and how the keys LFU change over time, which
  1906. # is possible to inspect via the OBJECT FREQ command.
  1907. #
  1908. # There are two tunable parameters in the Redis LFU implementation: the
  1909. # counter logarithm factor and the counter decay time. It is important to
  1910. # understand what the two parameters mean before changing them.
  1911. #
  1912. # The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis
  1913. # uses a probabilistic increment with logarithmic behavior. Given the value
  1914. # of the old counter, when a key is accessed, the counter is incremented in
  1915. # this way:
  1916. #
  1917. # 1. A random number R between 0 and 1 is extracted.
  1918. # 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1).
  1919. # 3. The counter is incremented only if R < P.
  1920. #
  1921. # The default lfu-log-factor is 10. This is a table of how the frequency
  1922. # counter changes with a different number of accesses with different
  1923. # logarithmic factors:
  1924. #
  1925. # +--------+------------+------------+------------+------------+------------+
  1926. # | factor | 100 hits   | 1000 hits  | 100K hits  | 1M hits    | 10M hits   |
  1927. # +--------+------------+------------+------------+------------+------------+
  1928. # | 0      | 104        | 255        | 255        | 255        | 255        |
  1929. # +--------+------------+------------+------------+------------+------------+
  1930. # | 1      | 18         | 49         | 255        | 255        | 255        |
  1931. # +--------+------------+------------+------------+------------+------------+
  1932. # | 10     | 10         | 18         | 142        | 255        | 255        |
  1933. # +--------+------------+------------+------------+------------+------------+
  1934. # | 100    | 8          | 11         | 49         | 143        | 255        |
  1935. # +--------+------------+------------+------------+------------+------------+
  1936. #
  1937. # NOTE: The above table was obtained by running the following commands:
  1938. #
  1939. #   redis-benchmark -n 1000000 incr foo
  1940. #   redis-cli object freq foo
  1941. #
  1942. # NOTE 2: The counter initial value is 5 in order to give new objects a chance
  1943. # to accumulate hits.
  1944. #
  1945. # The counter decay time is the time, in minutes, that must elapse in order
  1946. # for the key counter to be divided by two (or decremented if it has a value
  1947. # less <= 10).
  1948. #
  1949. # The default value for the lfu-decay-time is 1. A special value of 0 means to
  1950. # decay the counter every time it happens to be scanned.
  1951. #
  1952. # lfu-log-factor 10
  1953. # lfu-decay-time 1
  1955. ########################### ACTIVE DEFRAGMENTATION #######################
  1956. #
  1957. # What is active defragmentation?
  1958. # -------------------------------
  1959. #
  1960. # Active (online) defragmentation allows a Redis server to compact the
  1961. # spaces left between small allocations and deallocations of data in memory,
  1962. # thus allowing to reclaim back memory.
  1963. #
  1964. # Fragmentation is a natural process that happens with every allocator (but
  1965. # less so with Jemalloc, fortunately) and certain workloads. Normally a server
  1966. # restart is needed in order to lower the fragmentation, or at least to flush
  1967. # away all the data and create it again. However thanks to this feature
  1968. # implemented by Oran Agra for Redis 4.0 this process can happen at runtime
  1969. # in a "hot" way, while the server is running.
  1970. #
  1971. # Basically when the fragmentation is over a certain level (see the
  1972. # configuration options below) Redis will start to create new copies of the
  1973. # values in contiguous memory regions by exploiting certain specific Jemalloc
  1974. # features (in order to understand if an allocation is causing fragmentation
  1975. # and to allocate it in a better place), and at the same time, will release the
  1976. # old copies of the data. This process, repeated incrementally for all the keys
  1977. # will cause the fragmentation to drop back to normal values.
  1978. #
  1979. # Important things to understand:
  1980. #
  1981. # 1. This feature is disabled by default, and only works if you compiled Redis
  1982. #    to use the copy of Jemalloc we ship with the source code of Redis.
  1983. #    This is the default with Linux builds.
  1984. #
  1985. # 2. You never need to enable this feature if you don't have fragmentation
  1986. #    issues.
  1987. #
  1988. # 3. Once you experience fragmentation, you can enable this feature when
  1989. #    needed with the command "CONFIG SET activedefrag yes".
  1990. #
  1991. # The configuration parameters are able to fine tune the behavior of the
  1992. # defragmentation process. If you are not sure about what they mean it is
  1993. # a good idea to leave the defaults untouched.
  1995. # Enabled active defragmentation
  1996. # activedefrag no
  1998. # Minimum amount of fragmentation waste to start active defrag
  1999. # active-defrag-ignore-bytes 100mb
  2001. # Minimum percentage of fragmentation to start active defrag
  2002. # active-defrag-threshold-lower 10
  2004. # Maximum percentage of fragmentation at which we use maximum effort
  2005. # active-defrag-threshold-upper 100
  2007. # Minimal effort for defrag in CPU percentage, to be used when the lower
  2008. # threshold is reached
  2009. # active-defrag-cycle-min 1
  2011. # Maximal effort for defrag in CPU percentage, to be used when the upper
  2012. # threshold is reached
  2013. # active-defrag-cycle-max 25
  2015. # Maximum number of set/hash/zset/list fields that will be processed from
  2016. # the main dictionary scan
  2017. # active-defrag-max-scan-fields 1000
  2019. # Jemalloc background thread for purging will be enabled by default
  2020. jemalloc-bg-thread yes
  2022. # It is possible to pin different threads and processes of Redis to specific
  2023. # CPUs in your system, in order to maximize the performances of the server.
  2024. # This is useful both in order to pin different Redis threads in different
  2025. # CPUs, but also in order to make sure that multiple Redis instances running
  2026. # in the same host will be pinned to different CPUs.
  2027. #
  2028. # Normally you can do this using the "taskset" command, however it is also
  2029. # possible to this via Redis configuration directly, both in Linux and FreeBSD.
  2030. #
  2031. # You can pin the server/IO threads, bio threads, aof rewrite child process, and
  2032. # the bgsave child process. The syntax to specify the cpu list is the same as
  2033. # the taskset command:
  2034. #
  2035. # Set redis server/io threads to cpu affinity 0,2,4,6:
  2036. # server_cpulist 0-7:2
  2037. #
  2038. # Set bio threads to cpu affinity 1,3:
  2039. # bio_cpulist 1,3
  2040. #
  2041. # Set aof rewrite child process to cpu affinity 8,9,10,11:
  2042. # aof_rewrite_cpulist 8-11
  2043. #
  2044. # Set bgsave child process to cpu affinity 1,10,11
  2045. # bgsave_cpulist 1,10-11
  2047. # In some cases redis will emit warnings and even refuse to start if it detects
  2048. # that the system is in bad state, it is possible to suppress these warnings
  2049. # by setting the following config which takes a space delimited list of warnings
  2050. # to suppress
  2051. #
  2052. # ignore-warnings ARM64-COW-BUG

docker 容器中的 boot 如何访问 redis

同一网络配置下的 Boot 项目访问 Redis 的话，地址写 容器名称 container_name（一般还会设置 hostname）
需要注意的是，不像 boot 之间，或则 mq 那样需要写 http:// 为前缀，仅需要写 container_name 名称就可以了