Skip to main content

Technical Documentation

1. Platform Overview

  • Platform: BookStackApp (open-source documentation platform).
  • Purpose: Organize and share lore, fan fiction, and community-created content about the Homeworld universe.
  • Version: See the Log page.
  • Hosting: Self-hosted VPSΒ  on HetznerΒ  to provide control over customizations, performance, and security.

2. System Architecture

  • Server Environment:
    • Operating System: Ubuntu 24.04 LTS
    • Web Server: Apache2
    • Database: MariaDB
    • PHP Version: PHP 8.2
  • Application Stack:
    • BookStack: Built on Laravel (PHP) and Vue.js (JavaScript).
    • Database: Stores content, user accounts, and permissions in a relational database.
    • Caching: Configured with Laravel’s built-in caching system for improved performance.

3. Configuration

  • Primary Settings in .env:

    • APP_URL: https://www.homeworldlore.net (the main URL for the site).
    • APP_LANG: Set to en to restrict the interface to English only.
    • Mail Settings: Configured with SMTP for notifications, using Gmail.
    • Cache and Session: Session and cache storage are configured in the .env file to optimize performance.

  • Customizations:

    • Language Limitation: All non-English language files have been removed, ensuring the platform is English-only.
    • Embedded Google Form: A Google Form is embedded on the Contact page to handle user inquiries, using an iframe for seamless integration.
    • CSS to achieve a Homeworld look for Dark-Mode
Back to top