Deploy BookStack for Rust Cameroon Documentation

[sinke237]

📝 Description

This ticket tracks the deployment of the BookStack documentation platform using the code in the feature-documentation-website/bookstack](https://github.com/Rust-Cameroon/internals/tree/feature-documentation-website/bookstack) branch.

BookStack will serve as the centralized documentation system for the Rust Cameroon processes and technical documentation. It will be used by contributors, maintainers, and the community to manage both public and private knowledge in a structured and secure way.

---

Why This Deployment Is Necessary

• Centralized Knowledge Base: One unified place for internal notes, onboarding docs, working group outputs, and technical specs.
• Role-Based Access Control (RBAC): Manage visibility of sensitive or internal content while keeping other docs public.
• Structured Documentation: Hierarchical model (Shelves → Books → Chapters → Pages) improves navigation and organization.
• Improved Team Collaboration: Multiple contributors can collaborate with revision history and access controls.
• Scalable Documentation Workflow: Prepares the Rust Cameroon project for future growth and team onboarding.

---

🧰 Key Features of BookStack

• 🔐 Role-Based Access Control (RBAC)
• 🗂️ Clear hierarchy: Shelves → Books → Chapters → Pages
• ✍️ WYSIWYG + Markdown editing
• 🔄 Page revision history
• 🔎 Full-text search
• 🧩 REST API support
• 🔑 Authentication support (LDAP, SAML, OAuth optional)

---

📂 Repository & Branch

• Repository: [Rust-Cameroon/internals](https://github.com/Rust-Cameroon/internals)
• Branch: [feature-documentation-website/bookstack](https://github.com/Rust-Cameroon/internals/tree/feature-documentation-website/bookstack)

---

📦 Deployment Tasks

• Review the docker-compose setup in the bookstack folder
• Set up the hosting environment (ec2, subdomain)
• Configure environment variables (.env)
• Deploy to production
• Document access instructions (in README or onboarding doc)

---

📎 Notes

• Consider setting up backups (DB and uploads)
• Use HTTPS (e.g., Nginx/traefik + Let’s Encrypt)
• Optional: Set up GitHub OAuth or LDAP for SSO
• Track bugs or improvements in a separate issue

📎 Subdomain

docs.rustcameroon.com

[Christiantyemele]

@sinke237
I’ll start working on this as soon as I finish setting up the active deployment on our website.

Requirements:

• AWS EC2 (for deployment on AWS)

  • Requires account top-up

• Subdomain from rustcameroon.com

  • No additional fees required

[sinke237]

Hey @Christiantyemele
Please can you create an invoice for this so that@blessing can fund it.

Thank you!

[Christiantyemele]

Okay let me do that

…

On Wed, 1 Oct 2025 at 11:14 sinke237 ***@***.***> wrote: *sinke237* left a comment (Rust-Cameroon/internals#23) <#23 (comment)> Hey @Christiantyemele <https://github.com/Christiantyemele> Please can you create an invoice for this so ***@***.*** can fund it. Thank you! — Reply to this email directly, view it on GitHub <#23 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BCL3ZPLZF64WAATTLQOMEZL3VOSPBAVCNFSM6AAAAACHPYD5ZGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGNJVGY2DKNZVGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[Christiantyemele]

Done On Wed, 1 Oct 2025 at 11:14 Christian Yemele ***@***.***> wrote:

…

Okay let me do that On Wed, 1 Oct 2025 at 11:14 sinke237 ***@***.***> wrote: > *sinke237* left a comment (Rust-Cameroon/internals#23) > <#23 (comment)> > > Hey @Christiantyemele <https://github.com/Christiantyemele> > Please can you create an invoice for this so ***@***.*** can fund it. > > Thank you! > > — > Reply to this email directly, view it on GitHub > <#23 (comment)>, > or unsubscribe > <https://github.com/notifications/unsubscribe-auth/BCL3ZPLZF64WAATTLQOMEZL3VOSPBAVCNFSM6AAAAACHPYD5ZGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGNJVGY2DKNZVGI> > . > You are receiving this because you were mentioned.Message ID: > ***@***.***> >