Refactor Pritunl's cookbook

[diego-ojeda-binbash]

What?

• Refactor Pritunl's cookbook.

Why?

• Mainly to reorganize the cookbook into subpages as it was to long to read.

References

• Use closes #873

Important

Please include a screenshot of the pages that you modified to help reviewers. If you are using Chrome, you can follow the instructions below to easily take a full screenshot of the entire page:

1. Right click the page and open the inspector.
2. In the top left of Chrome Inspector you'll see a little phone icon whose tooltip shows "Toggle device emulation".
3. Hit that and a new black bar will appear on the top of the webpage.
4. In the black bar you can pick the dimensions of the screen you want to stimulate -- Since the documentation uses a responsive layout, you'll probably want to set a wide enough value on the width field, e.g. 1024x768, then the height is not as important.
5. In top right of black bar is three dots, in that menu you can do a full page screenshot.

Summary by CodeRabbit

• Documentation
  • Added "Evaluating Alternatives" page comparing AWS Client VPN and Pritunl with pros/cons and selection guidance.
  • Rewrote VPN Server index into a deployment-focused overview with clear deployment steps and links.
  • Substantially reorganized OpenTofu guidance: provisioning workflow, DNS notes, SSH/SSM access, port/security recommendations, and example snippets.
  • Revised Ansible guide for clearer prerequisites, playbook run steps, and repository/contact guidance.
  • Overhauled Pritunl GUI setup: TLS, user/org onboarding, server creation, routing, DNS, and security reset guidance.
  • Updated navigation to reorder and relabel VPN Server sections.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

Reworks the VPN Server documentation: adds an alternatives comparison page; restructures and rewrites OpenTofu provisioning, Ansible installation, and GUI configuration guides; updates the VPN index to a deployment-focused flow; and updates mkdocs navigation to reflect new section titles and ordering.

Changes

Cohort / File(s)	Summary
New alternatives comparison doc docs/user-guide/cookbooks/VPN-server/VPN-comparison.md	Adds "VPN Solution Alternatives" comparing AWS Client VPN and Pritunl with an overview, quick comparison table, detailed pros/cons, and guidance for choosing between options.
VPN Server landing / index docs/user-guide/cookbooks/VPN-server/index.md	Rewrites the landing page to a deployment-focused overview; replaces assumptions with an overview and a three-step deployment sequence linking to provisioning, Ansible, and GUI guides.
Provisioning with OpenTofu docs/user-guide/cookbooks/VPN-server/VPN-server-opentofu.md	Major rework: renamed sections, refactored provisioning workflow, reference code retrieval, applying changes, SSH/SSM access options, updated DNS/port/firewall examples, and Terraform/OpenTofu snippets.
Installing with Ansible docs/user-guide/cookbooks/VPN-server/VPN-server-ansible.md	Restructured to "Installing the Software": narrative prerequisites, clarified playbook execution (security/users and Pritunl playbooks), repo info, and wording/formatting updates.
Configuring Pritunl (GUI) docs/user-guide/cookbooks/VPN-server/VPN-server-gui-setup.md	Reworked GUI setup flow: connection/init steps, TLS/Let's Encrypt guidance, user/org onboarding, server creation flow, routing and AWS private DNS notes, and security/firewall adjustments.
Navigation update mkdocs.yml	Updates MkDocs navigation for VPN Server subtree: renames and reorders entries to "Evaluating Alternatives", "Provisioning the Infrastructure", "Installing the Software", "Configuring Pritunl" and remaps files accordingly.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Admin as Admin
  participant Docs as MkDocs Site
  participant Infra as OpenTofu/Terraform
  participant EC2 as EC2 (Pritunl)
  participant Ansible as Ansible
  participant Pritunl as Pritunl Web Admin

  Admin->>Docs: Read "Evaluating Alternatives" / follow links
  Admin->>Docs: Start deployment steps (1. Provision 2. Install 3. Configure)

  rect rgb(230,240,255)
    note over Admin,Infra: Step 1 — Provisioning the Infrastructure
    Admin->>Infra: Apply infra (VPC, EC2, DNS, security)
    Infra-->>EC2: Create instance and networking
  end

  rect rgb(235,255,235)
    note over Admin,Ansible: Step 2 — Installing the Software
    Admin->>Ansible: Run security/users playbook
    Ansible-->>EC2: Configure OS, users, firewall
    Admin->>Ansible: Run Pritunl playbook
    Ansible-->>EC2: Install and configure Pritunl
  end

  rect rgb(255,245,230)
    note over Admin,Pritunl: Step 3 — Configuring Pritunl (GUI)
    Admin->>Pritunl: Access web UI (TLS, initial setup)
    Admin->>Pritunl: Create orgs/users, servers, routes, auth
    Pritunl-->>Admin: Provide client profiles/connection details
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• Refactor Pritunl's cookbook #251 — Refactors the same VPN cookbook docs and modifies overlapping files (VPN-comparison, OpenTofu, Ansible, GUI, index, mkdocs.yml).

Suggested reviewers

• martingaleano
• exequielrafaela

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title accurately reflects the main change by indicating that the Pritunl cookbook documentation is being refactored, and it is concise and specific enough for teammates to understand the primary purpose of the pull request.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6d3c706 and a3cb83e.

📒 Files selected for processing (2)

• docs/user-guide/cookbooks/VPN-server/VPN-server-gui-setup.md (2 hunks)
• docs/user-guide/cookbooks/VPN-server/index.md (1 hunks)

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

docs/user-guide/cookbooks/VPN-server/VPN-server-gui-setup.md (1)

95-96: Fix “at last” typo in connection options.

The sentence should read “at least two options” instead of “at last two options.”

Apply this diff:

-There are at last two options to connect to the EC2 instance: SSH and SSM.
+There are at least two options to connect to the EC2 instance: SSH and SSM.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3a68d2a and 6d3c706.

📒 Files selected for processing (6)

• docs/user-guide/cookbooks/VPN-server/VPN-comparison.md (1 hunks)
• docs/user-guide/cookbooks/VPN-server/VPN-server-ansible.md (2 hunks)
• docs/user-guide/cookbooks/VPN-server/VPN-server-gui-setup.md (2 hunks)
• docs/user-guide/cookbooks/VPN-server/VPN-server-opentofu.md (1 hunks)
• docs/user-guide/cookbooks/VPN-server/index.md (1 hunks)
• mkdocs.yml (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/user-guide/cookbooks/VPN-server/VPN-server-gui-setup.md

33-33: Link text should be descriptive

(MD059, descriptive-link-text)

docs/user-guide/cookbooks/VPN-server/VPN-server-opentofu.md

33-33: Link text should be descriptive

(MD059, descriptive-link-text)

[angelofenoglio]

I agree with the small coderabbit suggestions, besides that, looks good!