Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add statelessness doc for users #408

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

davidjharder
Copy link
Member

Description

Statelessness doc for users.

Part of #400 and #305

Submitter Checklist

  • Squashed commits with git rebase -i (if needed)

@davidjharder davidjharder marked this pull request as draft October 13, 2023 17:11
Copy link
Contributor

@TraceyC77 TraceyC77 left a comment

Choose a reason for hiding this comment

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

This is a really good start. I would recommend having a warning / note box at the top of "Using statelessness" that if the user adds a custom config, it is their responsibility to make sure it still works after system updates.

I'd also recommend changing this subhead to "Customizing configurations" or such, since that's more relatable to the average user.
-or- separate out the topics. This doc for describing statelessness. The other doc (Configuration File Locations) can describe which configs should be edited to customize software. I'll write something up in the other one and we / the team can decide what looks best.


### TODO: Others?

- pam, ssl
Copy link
Contributor

Choose a reason for hiding this comment

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

samba, acupsd

Found this in /etc/, used by the APC UPS daemon (not installed by default, in the repos)

 ❯ head /etc/changeme                                                                                                                         [12:43:38]
#!/bin/sh
#
# This shell script if placed in /etc/apcupsd
# will be called by /etc/apcupsd/apccontrol when apcupsd
# detects that the battery should be replaced.
# We send an email message to root to notify him.

Copy link
Member Author

@davidjharder davidjharder Oct 13, 2023

Choose a reason for hiding this comment

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

In my mind, this list is for things that a typical user might change. I don't want to make an exhaustive list of all the configs we ship

For pam and ssl, I'm skeptical we should point users at these configs without some sort of big flashing danger sign

See #409

@davidjharder
Copy link
Member Author

Note to self: add the proper toml frontmatter

@Staudey Staudey mentioned this pull request Jan 31, 2024
1 task
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.

2 participants