Skip to content

docs: Improve FAQ entry for mail-state folder#2187

Merged
georglauterbach merged 7 commits intomasterfrom
docs/improve-faq-entry-mailstate
Sep 13, 2021
Merged

docs: Improve FAQ entry for mail-state folder#2187
georglauterbach merged 7 commits intomasterfrom
docs/improve-faq-entry-mailstate

Conversation

@polarathene
Copy link
Copy Markdown
Member

@polarathene polarathene commented Sep 12, 2021

Description

  • Update ENV docs for ONE_DIR to reflect new default 1 value.
  • Links to relevant script logic.
  • Better list of services data moved to mail-state.

Type of change

  • Improvement (non-breaking change that does improve existing functionality)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • New and existing unit tests pass locally with my changes

- Links to relevant script logic.
- Better list of services data moved to `mail-state`.
casperklein
casperklein previously approved these changes Sep 12, 2021
Copy link
Copy Markdown
Member

@casperklein casperklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add further information why mail-state is useful: It preserves the service data between container restarts. Otherwise fail2ban information (blocks) are lost and clamav patterns need to be downloaded again and may not up2date for a time period.

@polarathene
Copy link
Copy Markdown
Member Author

why mail-state is useful: It preserves the service data between container restarts.

"this folder will store the data from internal services so that you can more easily persist state." should communicate that?

Otherwise fail2ban information (blocks) are lost and clamav patterns need to be downloaded again and may not up2date for a time period.

Sure some examples can be added I guess 👍

Comment thread docs/content/faq.md Outdated
Co-authored-by: Brennan Kinney <[email protected]>
casperklein
casperklein previously approved these changes Sep 12, 2021
@polarathene

This comment has been minimized.

This was missed during the `ONE_DIR` default change in #2148
Comment thread docs/content/config/environment.md Outdated
Copy link
Copy Markdown
Member

@wernerfred wernerfred left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed a broken link

PS: So glad we build the docs preview ❤️

Comment thread docs/content/config/environment.md Outdated
Copy link
Copy Markdown
Member

@wernerfred wernerfred left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 📄

Copy link
Copy Markdown
Member

@georglauterbach georglauterbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions
Copy link
Copy Markdown
Contributor

Documentation preview for this PR is ready! 🎉

Built with commit: d8c7ed7

@georglauterbach georglauterbach merged commit 2bc3e82 into master Sep 13, 2021
@georglauterbach georglauterbach deleted the docs/improve-faq-entry-mailstate branch September 13, 2021 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants