docker-mailserver / docker-mailserver/docker-mailserver

[TODO]: Review Redis config

Open
#3,855 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area/configuration (file) area/documentation kind/improvement meta/help wanted stale-bot/ignore
Dominant language
Shell
Stars
18.9k
Forks
2k
Avg merge
5h 15m
Merged PRs (30d)
28

Description

Description

I saw these past comments of mine while looking into separate issue about our logging support, figured it might be worth raising a TODO issue if anyone has time.

For Debian Bookworm / DMS v14, I take it there is no issues with the Redis v7 upgrade, and no complaints about persistence config have come up since the review feedback.

Feel free to close this issue if it doesn't seem relevant, I'm not likely to have time to invest towards it myself. This is more for maintainer documentation / discovery reasons 😅


Presently dependent upon config shipped by default / Debian package, and modifying that:

https://github.com/docker-mailserver/docker-mailserver/blob/23705e6712cd5b9cacf4cf8b5e7bfc3375e72e2e/target/scripts/startup/setup.d/security/rspamd.sh#L117-L145

https://github.com/docker-mailserver/docker-mailserver/blob/23705e6712cd5b9cacf4cf8b5e7bfc3375e72e2e/target/supervisor/conf.d/supervisor-app.conf#L108-L115

Concerns / Advice provided previously:

For maintenance, it'd probably be worthwhile to document the configuration changes. Some of the changes aren't obvious why they're done (as per review feedback below), where the only context available is git blame (until some eventual refactoring adds friction there 😬 )


References

Screenshots because I'm lazy.

Debian Bookworm upgrade (Redis v7)

The 2nd linked comment also expresses a concern for Redis v7 upgrade with Debian Bookworm:

Be mindful of Redis version and the major bump when Debian releases Bookworm, and reliance on implicit config (especially when it differs from what Redis ships / documents).

image

There was also another review comment there on the config contributed, with an intent for it to be reviewed for Debian Bookworm update (I don't think that was done yet?):

image


Persistence

Related was a concern about how persistence would be configured and changes in that support with v7 of Redis (additionally noting a difference in Debian shipped config vs upstream Redis):

image

image

Out of the two persistence links to Redis docs originally provided, only one is still valid. The other appears to now be located here.


Log config

Separate concern was expressed regarding log config (which may be more relevant [when Vector is adopted into DMS])https://github.com/docker-mailserver/docker-mailserver/issues/3561)):

image

image

From upstream Redis config docs (should be the default for us due to removing the config line, thus stdout to file through supervisord):

image

NOTE: /var/log/{redis,rspamd} exist as directories. Presumably left-over from Debian package installs? 🤷‍♂️

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with target/scripts/startup/setup.d/security/rspamd.sh and target/supervisor/conf.d/supervisor-app.conf, then read the linked Redis persistence documentation and the prior issue and pull-request review comments. Determine whether the Debian Bookworm/Redis v7, persistence, and logging configuration needs changes; done means the decisions and rationale are documented, or the issue is closed as unnecessary.

Written by the indexing model from the issue text.

Assessment

Tech stack
debian, redis, shell
Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.