Server Environment: <server-name>

This document describes the hosting environment for <server-name>, including the Pterodactyl configuration, resource allocations, container image, storage mounts, and network configuration.

This document reflects the current deployment environment for <server-name> and serves as the reference for its Pterodactyl configuration.

Server startup arguments, runtime configuration, and application-specific settings should be documented separately where appropriate.

Node hardware details and Pterodactyl infrastructure information are documented separately in ../../infrastructure.md and the corresponding node documentation.


Document Scope

This document describes:

It does not document:

Those topics should be documented separately where appropriate.


Server Overview

Item Value
Server Name
Current Wings Node <Node name>
Application/Game
Application Version
Framework/Loader
Framework/Loader Version

Operational procedures, startup configuration, backup procedures, and application-specific guidance should be documented separately in related documentation.


Pterodactyl Deployment

This server is deployed using a self-hosted Pterodactyl installation running on the <node-name> Wings node.

Current deployment:

Platform:
Pterodactyl

Wings Node:
`<Node name>`

This server can be migrated between Wings nodes when required. If migration occurs, this document should be updated with the new node assignment.

Node-specific hardware information is documented separately in the corresponding node documentation.


Egg Configuration

The server uses the following Pterodactyl egg:

Item Value
Nest
Egg
Egg Source <Source/repository>
Egg Author
Egg UUID
Egg Customizations

Document any egg-specific changes or customizations here.

Startup commands and runtime configuration should be documented separately.


Container Image

Configured container image:

<Container image>

This image provides the container environment and runtime used by the server.

Runtime versions and startup configuration should be documented separately.

When changing runtime versions, the container image and startup configuration should be reviewed together.


Resource Allocation

Configured Pterodactyl resource limits:

Resource Value
CPU Limit
CPU Pinning
Memory
Swap
Disk Space Limit
Block I/O Weight
OOM Killer <Enabled/Disabled>
Database Limit
Allocation Limit
Backup Limit

CPU Allocation

CPU Limit

The CPU limit is configured as:

<Value>

Document whether CPU quota limits, CPU pinning, or another method controls CPU availability.


CPU Pinning

The server is pinned to the following logical CPU threads:

<CPU affinity>

Document the CPU topology relationship if CPU pinning is used.

Example:

Physical Core Logical CPUs

CPU topology is specific to the current host hardware. If the server is migrated to another node, CPU pinning should be reviewed.


Memory Allocation

The configured memory allocation is:

<Memory allocation>

Document how allocated memory is expected to be used.

Consider documenting:

The Pterodactyl memory allocation should remain higher than any configured application runtime limit.


Swap Allocation

Swap configuration:

<Swap allocation>

Document any reasoning behind the swap configuration.


OOM Killer

Pterodactyl OOM Killer setting:

<Enabled/Disabled>

Document any considerations related to memory exhaustion handling.


Storage Configuration

Container Storage

The server operates within the standard Pterodactyl container filesystem:

/home/container/

Files referenced by startup commands are relative to this working directory unless otherwise specified.


Mounted Storage

The server uses the following external mounts:

Item Value
Mount Name
Source
Target

Purpose:


Networking

Network configuration:

Item Value
Server Hostname
Application Connection <Address/port>
Additional Services
Reverse Proxy
Dynamic DNS <Enabled/Disabled>
SRV Records <Enabled/Disabled>

Document any additional protocol requirements.

Example:

Simple Voice Chat:
Protocol:
UDP

Backup Configuration

Pterodactyl Backups

Configured backup limit:

<Number>

Backup schedule:

<Schedule or manual>

Backup storage location:

<Path>

Document retention settings and recovery considerations.


Application-Specific Backups

Application-specific backups:

<Configuration>

Document any external backup systems or mounts used by the application.


Migration Considerations

This server can be migrated between Wings nodes when required.

Before migrating this server, verify:

Document any server-specific migration considerations here.


Security Configuration

Current deployment characteristics:

Do not document passwords, tokens, API keys, or other sensitive credentials here.


Related Documentation

The following documents provide additional information about this server and the infrastructure on which it runs.

Document Purpose
server-configuration.md Non-default server and application-related configuration changes
server-startup.md Runtime configuration, startup command, and application arguments
modpack.md (planned) Modpack overview, installed components, and selection rationale
disabled-mods.md Disabled components and the reasons they are disabled
server-management.md (planned) Operational procedures and maintenance
mod-management.md (planned) Component installation and update procedures
server-backup-strategy.md (planned) Backup procedures, validation, and recovery
../../infrastructure.md Overall Pterodactyl deployment, storage, networking, and infrastructure
../../nodes/<node-name>.md Hardware and configuration details for the current Wings node

Future Review Considerations

Review this document whenever any of the following change:


Change History

YYYY-MM-DD

Initial documentation created for the current Pterodactyl deployment configuration.

This document records the deployed server environment and does not cover historical hosting configurations.