Infrastructure Documentation

This repository contains documentation for the hosted services, physical nodes, infrastructure configuration, and operational procedures.

The documentation reflects the current deployed environment and the intended long-term organization of this repository. Documents marked with (planned) are intended to be created but do not currently exist.

The documentation should be updated when significant changes are made.

Documentation Scope

This documentation covers:

• Physical hosts and their capabilities.
• Pterodactyl deployments.
• Hosted game servers.
• Storage configuration.
• Network configuration.
• Operational procedures.
• Supporting services.

Infrastructure changes should be documented in the appropriate location:

• Hardware changes → nodes/
• Hosted server changes → servers/
• Shared infrastructure changes → infrastructure.md or services/
• New reusable document formats → templates/

Public Services

The infrastructure documented in this repository supports public services available through:

• https://www.gorgarath.net

Documentation Principles

• Never store passwords, API keys, tokens, private keys, or other sensitive credentials in documentation. Use an appropriate secrets management solution instead.
• Document the current configuration rather than historical configurations.
• Record the reasoning behind significant decisions.
• Update documentation whenever configuration changes are made.
• Use the restart-only maintenance policy for Mustard and future heavily modded Minecraft servers; deliberate reload investigation belongs in an authorized disposable environment.
• Keep infrastructure, node, server, and service documentation separated by responsibility.
• Document each component in the location where its configuration is managed.
• Prefer relative paths and repository-based references so documentation can be moved between local storage, Git, or web hosting without requiring major changes.

File Naming Conventions

• Use lowercase filenames.
• Use hyphens to separate words.
• Use .md for Markdown documentation files.
• Use directories to define document categories.
• Use *(planned)* for documents that are intended but not yet created.

Markdown Style Conventions

• Use ATX-style Markdown headings (#, ##, and ###) with title-style capitalization.
• Separate major ## sections with a horizontal rule (---).
• Use standard Markdown pipe tables consistently within a document.
• Use inline code formatting for hostnames, paths, configuration keys, commands, and literal values when they appear in prose.
• Use fenced code blocks for commands or multi-line examples and indented blocks for short displayed configuration values where appropriate.
• Use pregeneration as one word throughout the documentation.
• Begin every document with its scope as the first major section. Substantive documents use Document Scope; the repository README uses Documentation Scope because it defines the scope of the repository as a whole.
• For substantive documents other than the repository README, place document-specific maintenance, review, or notes sections before Related Documentation, and keep Change History as the final major section.
• Include Related Documentation in substantive infrastructure, node, server, and service documents; its links should be specific to the document.
• List Change History entries newest first and use only one ### YYYY-MM-DD heading per date. Use - bullets for distinct changes or results and combine multiple changes made on the same date under that heading.

Directory Structure

Document Index

Infrastructure

Nodes

Nodes are listed by operational importance rather than alphabetical order.

Servers

Individual server documentation is stored in per-server subdirectories under servers/.

Example:

servers/<server-name>/

Expected documentation files within each server directory:

Some servers may contain additional documents or may not require all of these files.

Services

The services/ directory is reserved for shared services that support the infrastructure. Because Git does not track empty directories, it is not present in the repository until the first service document is added.

Services should be documented separately from physical nodes and individual servers.

Planned documentation may include:

Templates

The templates/ directory contains templates for creating new documentation files.

Current templates:

Change History

2026-10-18

• Linked the restart-only maintenance policy for heavily modded Minecraft servers.

2026-09-25

• Added the Mustard modpack, mod-management, server-management, and backup-strategy documents to the repository index.

2026-09-19

• Standardized repository Markdown style conventions.
• Updated the node documentation index for the standardized wings00, wings01, and wings02 naming scheme.
• Clarified that the planned services/ directory is absent until it contains a tracked document.
• Removed the obsolete duplicate server-template.md; server-environment-template.md is the maintained environment template.
• Added AGENTS.md with repository instructions for automated documentation work.

2026-08-04

• Added a Public Services section with a reference to the public website.
• Updated documentation wording to clarify planned document markers.

2026-08-03

• Expanded the server documentation index to reflect the current documentation structure.

• Standardized document names and planned documentation entries.

• Added the server configuration template and updated template references.

• Refined the documentation index to better define repository organization, improve navigation, clarify documentation conventions, and add planned documentation entries for future server and service documentation.

2026-08-02

• Updated the documentation index to better reflect the repository structure, server documentation conventions, and planned migration to Git.

2026-07-26

• Documentation structure updated to separate infrastructure, nodes, servers, services, and templates.

• This layout is intended to support future migration to Git or web-based documentation hosting.