Skip to content

Commit a6bed08

Browse files
authored
docs: add more info about optimized config, fixes #48 (#49)
1 parent 5bbbf32 commit a6bed08

File tree

1 file changed

+23
-13
lines changed

1 file changed

+23
-13
lines changed

README.md

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,29 @@ After installation, make sure to commit the `.ddev` directory to version control
3636

3737
Redis is available inside Docker containers with `redis:6379`.
3838

39+
## What makes the optimized config different?
40+
41+
The default config only uses the [redis.conf](./redis/redis.conf) file.
42+
43+
The optimized config uses all `*.conf` files in the [redis](./redis) directory except `redis.conf`.
44+
45+
It uses *hardened* settings ready for production, like enabling Redis credentials.
46+
47+
You can read each config file to see the exact differences.
48+
49+
## Redis Credentials
50+
51+
By default, there is no authentication.
52+
53+
If you have the optimized config enabled, the credentials are:
54+
55+
| Field | Value |
56+
|----------|---------|
57+
| Username | `redis` |
58+
| Password | `redis` |
59+
60+
For more information about ACLs, see the [Redis documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/).
61+
3962
### Swappable Redis backends
4063

4164
Use the `ddev redis-backend` command to swap between Redis backends:
@@ -53,19 +76,6 @@ Use the `ddev redis-backend` command to swap between Redis backends:
5376
>
5477
> Example: `ddev redis-backend redis optimize`
5578
56-
## Redis Credentials
57-
58-
By default, no authentication is required.
59-
60-
If you have the optimized config enabled (`ddev dotenv set .ddev/.env.redis --redis-optimized=true`), the credentials are:
61-
62-
| Field | Value |
63-
|----------|---------|
64-
| Username | `redis` |
65-
| Password | `redis` |
66-
67-
For more information about ACLs, see the [Redis documentation](https://redis.io/docs/latest/operate/oss_and_stack/management/security/acl/).
68-
6979
## Advanced Customization
7080

7181
To apply an optimized configuration from `ddev/ddev-redis-7`:

0 commit comments

Comments
 (0)