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

chore: improve installer config documentation #777

Merged
merged 2 commits into from Feb 1, 2024
Merged

chore: improve installer config documentation #777

merged 2 commits into from Feb 1, 2024

Conversation

XavierChanth
Copy link
Member

- What I did

Updated the configuration files for srvd and sshnpd with better documentation and made them easier to configure.

- How I did it

- How to verify it

- Description for the changelog
chore: improve installer config documentation

# Make this unit fail if sshd isn't started first
Requisite=sshd.service
# Uncomment the following line to make this unit fail if sshd isn't started first
; Requisite=sshd.service
Copy link
Member Author

Choose a reason for hiding this comment

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

Both # and ; make valid comments in systemd unit files, so I used ; to represent items that can be uncommented

cconstab
cconstab previously approved these changes Feb 1, 2024
Copy link
Member

@cconstab cconstab left a comment

Choose a reason for hiding this comment

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

looks great..

atsign="@my_rvd" # MANDATORY: Srvd atSign
internet_address="" # MANDATORY: Public FQDN or IP address of the machine running the srvd
v="-v" # Comment to disable verbose logging

Copy link
Member Author

Choose a reason for hiding this comment

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

Now says Comment to disable verbose logging


# Uncomment if you wish the daemon to update authorized_keys to include public
# keys sent by authorized manager atSigns
# s="-s"
Copy link
Member Author

Choose a reason for hiding this comment

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

Separated -s and -u to their own comment blocks

@gkc gkc merged commit f9b2d1a into trunk Feb 1, 2024
6 checks passed
@gkc gkc deleted the installer-docs branch February 1, 2024 22:42
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.

None yet

3 participants