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

Completed draft of Administrator guide #132

Open
wants to merge 43 commits into
base: main
Choose a base branch
from
Open

Conversation

jdormansteele
Copy link
Contributor

@jdormansteele jdormansteele commented Mar 3, 2025

Note: Pending PR https://github.com/katzenpost/website/pull/131needs to be merged before this PR is merged.

This draft of the entire Admin Guide is submitted for final review preliminary to publishing. Here is a new PDF of the guide:
admin_guide.pdf

The following topics are new:

Several other topics have been touched with minor revisions.

Certain proposed topics related to configuration have been moved to a to-do directory and are not part of this draft. This is because configuration is currently an unresolved user experience and a subject of debate among the developers. This situation must not block the rest of the guide. The affected topics include Gensphinx, Tuning, a summary introduction, and any future topics such as a publicly usable genconfig.

The uncertainty surrounding configuration is handled in the new Installation topic with a recommendation to contact the project developers for assistance.

I request review of the new topics be completed and merged by the end of the week and that the finished document be published at that time. This will complete my responsibilities under WHS MoU 5.1, allowing me to invoice for it.

@david415
Copy link
Member

david415 commented Mar 4, 2025

in the quick start docs, please remove "pq-" from the service names.

systemctl start pq-katzenpost-mixserver

@david415
Copy link
Member

david415 commented Mar 4, 2025

generally, remove "pq" from the docs if it appears anywhere; it serves no purpose other than to make names longer and more cumbersome. more of such strings containing "pq" are present in the installation doc as well.

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