Skip to content

docs(rspamd): Add guidance for setting WebUI password#4023

Merged
georglauterbach merged 4 commits intodocker-mailserver:masterfrom
jiriks74:master
May 20, 2024
Merged

docs(rspamd): Add guidance for setting WebUI password#4023
georglauterbach merged 4 commits intodocker-mailserver:masterfrom
jiriks74:master

Conversation

@jiriks74
Copy link
Copy Markdown
Contributor

@jiriks74 jiriks74 commented May 19, 2024

Description

Added a section for setting up a password for the rspamd WebUI which is needed in order to make use of it.

Fixes #4022

Type of change

  • This change requires a documentation update

Checklist

I think that the options below do not apply to a simple documentation update

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary, I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added information about changes made in this PR to CHANGELOG.md

@jiriks74 jiriks74 mentioned this pull request May 19, 2024
Closed
1 task
polarathene
polarathene requested changes May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

I'll apply this, feel free to discuss the revision.

Comment thread docs/content/config/security/rspamd.md Outdated
polarathene
polarathene approved these changes May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I'm not too familiar with rspamd myself, so I'll hold off until @georglauterbach reviews, just in case I've worded something wrong 😅

I think that the options below do not apply to a simple documentation update

👍

Rendered preview:

image

@polarathene polarathene changed the title fix(docs/rspamd): Add section on how to setup WebUI password docs(rspamd): Add guidance for setting WebUI password May 20, 2024
@polarathene polarathene added kind/improvement Improve an existing feature, configuration file or the documentation area/documentation service/security/rspamd labels May 20, 2024
@polarathene polarathene added this to the v14.0.0 milestone May 20, 2024
@jiriks74
Copy link
Copy Markdown
Contributor Author

jiriks74 commented May 20, 2024

I'm on my phone RN (internet not working) so I have limited functionality on GitHub.

I think that the rspamdm pw line should have this for the docker part docker exec -ti <CONTAINER NAME>.

It's like this in other places of the documentation so I'd try to keep it consistent.

https://docker-mailserver.github.io/docker-mailserver/latest/usage/#get-up-and-running

jiriks74
jiriks74 commented May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor Author

@jiriks74 jiriks74 left a comment

Choose a reason for hiding this comment

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

dms is not the default container name see

docker-mailserver/compose.yaml

Line 4 in 03c905e

container_name: mailserver

I'd either change this to the default or something else that is already used in docs.

Comment thread docs/content/config/security/rspamd.md Outdated
polarathene
polarathene requested changes May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

I'll apply it 👍

Comment thread docs/content/config/security/rspamd.md Outdated
Comment thread docs/content/config/security/rspamd.md Outdated
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 20, 2024

Documentation preview for this PR is ready! 🎉

Built with commit: f12b8a3

polarathene
polarathene approved these changes May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

LGTM 👍

Sorry about the added noise, shifted some links to the end of the file as a bit of a tidyup.

@jiriks74
Copy link
Copy Markdown
Contributor Author

jiriks74 commented May 20, 2024

The noise seems fine it's not that many changes.

Otherwise LGTM.

@georglauterbach georglauterbach merged commit 92b06c4 into docker-mailserver:master May 20, 2024
@polarathene polarathene mentioned this pull request Nov 14, 2025
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@polarathene polarathene polarathene approved these changes

@georglauterbach georglauterbach georglauterbach approved these changes

Assignees

No one assigned

Labels

area/documentation kind/improvement Improve an existing feature, configuration file or the documentation service/security/rspamd

Projects

None yet

Milestone

v14.0.0

Development

Successfully merging this pull request may close these issues.

[BUG]: RSPAMD needs a password for the web interface

3 participants

@jiriks74 @polarathene @georglauterbach