Repository navigation
docs: add server hosting guides - #4
Merged
Merged
Conversation
Add three guides for server owners, modeled on the Kingdoms Connected hosting section: Hosting a server (end-to-end install, Foundations, ports, masterlist, systemd, updates, troubleshooting), Server configuration (every server.json key, CLI flags, passwords, required mods, autoRespawn, info API) and Docker and game panels (the public GHCR image, Compose, Pterodactyl/Pelican egg). Content follows hogwarts-mp/hosting, corrected against the 1.8.0 server: all server.json keys are optional, maxplayers defaults to 32 with a cap of 128, and password, apihost, apiport, mod.autoRespawn and the CLI overrides are documented. Give every guide an explicit sidebar order so the nav reads Overview, Your first resource, Events, then the hosting pages instead of sorting by filename, and link the hosting pages from the overview.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a server-owner section to the guides, modeled on the Kingdoms Connected hosting pages and built from hogwarts-mp/hosting.
/guides/hosting/): a numbered walkthrough from a fresh machine to a joinable server. It covers the release ZIP, the Windows and Linux installs, a minimalserver.json, Foundations, ports, starting and joining (includinghogwartsmp://links), and masterlist listing. It ends with systemd, the update checklist and a troubleshooting table./guides/server-config/): everyserver.jsonkey with its default, startup validation and its error messages, command-line flags, passwords, required CurseForge mods,mod.autoRespawn, and the HTTP info API./guides/docker/): the publicghcr.io/hogwarts-mp/hogwartsmp-serverimage, Compose, the data volume, port overrides, updating, and the Pterodactyl/Pelican egg.Every guide now has an explicit
sidebar.order, so the nav reads Overview, Your first resource, Events, then the three hosting pages. Before this it sorted by filename (Events, Your first resource, Overview). The Overview's "Finding your way" section links the new pages.Corrections relative to hogwarts-mp/hosting
Checked against the 1.8.0 server source (Framework pin 33.0.1) and the published 1.8.0 image:
server.jsonkeys are optional now; a missing one takes its default. TheJSON config has missing fieldserror no longer exists. A key with the wrong type fails withJSON config could not be applied: … type must be ….maxplayersdefaults to 32 and is capped at 128.server.json.examplesays the default is 512.password,apihost,apiport,mod.autoRespawn, and-p/-h/-P/-H/-t/-c/--password.TRACY_NO_INVARIANT_CHECK=1.Follow-ups outside this repo
server.json.exampleshould get the same corrections./usr/share/hogwartsmp/at mode0444, so its default user can't open the bundled egg. The guide extracts it with--user 0. Giving the directory0555in the Dockerfile would fix it.WEB_PORTandSERVER_TOKEN. Panel users can't set Foundations' secrets orTRACY_NO_INVARIANT_CHECK.Verification
/guides/…link and#anchorresolves against the built HTML.