|
|
| Line 1: |
Line 1: |
|
| |
|
| = AMP Game Servers – User Guide =
| | [https://cubecoders.com/AMP AMP] is applicaton management panels for game servers like Minecraft, 7 Days to Die, Satisfactory, Valheim, Rust, Factorio, Terraria (Including tModLoader), Garry's Mod, many more games, and NodeJS and Python bots/applications |
| '''AMP''' (Application Management Panel by CubeCoders) is our self-service panel for running game servers (Minecraft, Valheim, Terraria, CS2, Factorio, … over 100 games). Any Base48 member with an SSO account can log in, create a server, and manage it from the browser.<div style="border:1px solid #c8ccd1; border-left:4px solid #36c; padding:0.5em 1em; margin:1em 0;">This is a '''trust-based''' setup: everyone who logs in has '''full admin rights''' over the whole panel. See the [[AMP (Application Management Panel)#Common rules|common rules]] below. They're short.</div>
| |
|
| |
|
| == Quick facts == | | === How to access? === |
| {| class="wikitable"
| | It is hosted at http://amp.at.base48.cz/ |
| !Panel URL
| |
| |http://amp.at.base48.cz
| |
| |-
| |
| !Login
| |
| |'''Base48 Keycloak SSO''' (your normal Base48 account)
| |
| |-
| |
| !Server address for games
| |
| |<code>amp.at.base48.cz</code> (or <code>10.48.0.130</code>) + your server's game port
| |
| |-
| |
| !Reachable from
| |
| |The Base48 network (wifi / LAN / VPN)
| |
| |-
| |
| !Shared resources
| |
| |16 CPU cores, 32 GB RAM, ~500 GB disk, '''shared by everyone'''
| |
| |-
| |
| !Admin contact
| |
| |Infra admins – see [[AMP/Infrastructure]]
| |
| |}
| |
|
| |
|
| == 1. Logging in ==
| | Login using OIDC, your Base48 account |
|
| |
|
| # Open '''http://amp.at.base48.cz''' while you are on the Base48 network.
| | Panel and servers are accessible only on local network (for now). |
| #* Use this hostname, not the IP. SSO login only works with the hostname.
| |
| # Click '''Base48 Keycloak SSO'''.
| |
| # Log in with your Base48 account. On your first login, AMP creates your user for you.
| |
| # You land on the '''Instances''' screen. It lists every game server on the box.
| |
|
| |
|
| '''Trouble logging in?'''
| |
|
| |
|
| * ''No admin menus / "Access denied" errors'': log out ('''your name, top right → Logout''') and log in again. AMP only reads your permissions when you log in.
| | Free to host anything you want, stop servers if not used for longer period of time. Delete if dead for a long time. |
| * ''AMP logs you straight back in as the old session'': use a private/incognito window.
| |
| * ''The page doesn't load'': check you are on the Base48 network.
| |
|
| |
|
| == 2. Creating a game server ==
| | Backups are daily through proxmox lxc, setup your own local backups on schedule you need. |
|
| |
|
| # On the '''Instances''' screen, click '''Create Instance''' (the <code>+</code> button).
| | Managed by respi |
| # Choose the '''Application''' (e.g. ''Minecraft Java Edition'', ''Valheim'', ''Terraria'' …).
| |
| # Set a '''Friendly Name''' that '''starts with your nickname''', e.g. <code>pepa-minecraft</code>. Everyone can then see whose server it is.
| |
| # '''Leave the IP binding and ports on their defaults''' unless you know you need something else. AMP picks free ports automatically.
| |
| # Click '''Create Instance'''. AMP downloads the game server (this can take a few minutes for Steam games) and starts it.
| |
| # When the instance shows as '''running''', click it to open its own management panel.
| |
| | |
| == 3. Connecting to your server ==
| |
| | |
| # Open your instance → '''Status''' page (or '''Configuration → Server and Ports''').
| |
| # Note the '''game port''' (e.g. Minecraft: <code>25565</code>).
| |
| # In the game, connect to <code>amp.at.base48.cz:PORT</code> (or <code>10.48.0.130:PORT</code>).
| |
| | |
| Examples:
| |
| | |
| * Minecraft Java: <code>amp.at.base48.cz:25565</code>
| |
| * Valheim: <code>amp.at.base48.cz:2456</code>
| |
| | |
| <div style="border:1px solid #c8ccd1; border-left:4px solid #36c; padding:0.5em 1em; margin:1em 0;">Servers are reachable '''from the Base48 network only'''. If you need a server reachable from the internet, ask an infra admin (it needs a port forward).</div>
| |
| | |
| == 4. Managing your server ==
| |
| Click your instance in the Instances list to open it. The main pages are:
| |
| {| class="wikitable"
| |
| !Page
| |
| !What it's for
| |
| |-
| |
| |'''Status'''
| |
| |Start / Stop / Restart / Update buttons, CPU/RAM usage, player count
| |
| |-
| |
| |'''Console'''
| |
| |Live server log and a command line (e.g. Minecraft <code>op pepa</code>, <code>whitelist add …</code>)
| |
| |-
| |
| |'''Configuration'''
| |
| |Game settings (difficulty, max players, world name, password, game version …)
| |
| |-
| |
| |'''File Manager'''
| |
| |Browse, upload and download files (worlds, mods, plugins, configs). Supports drag & drop and zip extraction.
| |
| |-
| |
| |'''Backups'''
| |
| |Take a backup now, restore one, download it
| |
| |-
| |
| |'''Schedule'''
| |
| |Automatic tasks, e.g. a nightly backup, a daily restart, or auto-updates
| |
| |-
| |
| |'''Users / Players'''
| |
| |Online players, kick/ban, whitelist
| |
| |}
| |
| | |
| === Common tasks ===
| |
| | |
| ; Update the game server
| |
| : '''Status → Update''' (stop the server first). For Minecraft, change the version under '''Configuration → Minecraft → Server Type / Version''', then click Update.
| |
| | |
| ; Install mods / plugins / a modpack
| |
| : ''Minecraft'': '''Configuration → Minecraft''' to pick Forge / Fabric / Paper, or use the built-in modpack installer. Otherwise, upload jars into <code>mods/</code> or <code>plugins/</code> with the '''File Manager'''.
| |
| | |
| ; Upload an existing world
| |
| : Stop the server → '''File Manager''' → upload a zip → right-click → '''Extract''' → set the world name in Configuration → Start.
| |
| | |
| ; Make a backup before you change something risky
| |
| : '''Backups → Take Backup'''. Restoring overwrites the current files.
| |
| | |
| ; Make it start automatically when the box reboots
| |
| : On the main '''Instances''' screen, open your instance's menu and enable '''Start on boot'''.
| |
| | |
| ; Let a friend manage your server
| |
| : Everyone can already manage every server. Just tell them which one is yours.
| |
| | |
| ; Delete your server
| |
| : Stop it → on the Instances screen click the '''trash icon''' on your instance. '''This deletes all its files and backups.''' Download a backup first if you want to keep the world.
| |
| | |
| == Common rules ==
| |
| '''Your servers, your rules – YOLO them.''' If you know what you're doing, you can do pretty much anything that's beneficial for the hackerspace. Take whatever resources you need.
| |
| | |
| * '''Your own servers:''' do whatever you want. Experiment, break things, rebuild.
| |
| * '''Other people's servers:''' leave them alone unless the owner is OK with it. Name yours <code>nick-something</code> so everyone knows whose it is.
| |
| * '''Core panel stuff''' (SSO/login, users & roles, network settings of the main panel): go ahead if you know what you're doing. A broken login locks everyone out, though. If you change something there, tell the infra admins or note it on [[AMP/Infrastructure]].
| |
| * '''Clean up after yourself:''' delete servers you've abandoned.
| |
| * '''Members' rules apply''': nothing illegal.
| |
| | |
| == FAQ ==
| |
| | |
| ; I don't see admin menus or I get "Access denied"
| |
| : Log out and log back in via SSO. If it still happens, ask an infra admin.
| |
| | |
| ; Can I use SFTP / FileZilla / WinSCP?
| |
| : Yes, with an '''SSH key''' (SSO accounts have no AMP password, so password login won't work):
| |
| :# Click '''your name (top right)''' to open your profile and add your '''SSH public key''' (e.g. the contents of <code>~/.ssh/id_ed25519.pub</code>). No key yet? Run <code>ssh-keygen -t ed25519</code>.
| |
| :# Find your instance's '''SFTP port''': open the instance, go to its settings and search for "SFTP". Each server has its own port, e.g. 2224.
| |
| :# Connect with your SFTP client to <code>amp.at.base48.cz</code> on that port, using your '''AMP username''' (shown top right) and your '''private key'''.
| |
| :# You land in that instance's files.
| |
| : For quick changes, the built-in '''File Manager''' in the browser also works.
| |
| | |
| ; My server won't start
| |
| : Check the '''Console''' for the error. Common causes: port already used by another server (pick another port in Configuration), wrong Java/game version, not enough RAM set for a modpack.
| |
| | |
| ; Is my world backed up automatically?
| |
| : '''Yes, daily, as part of the whole box.''' The whole AMP container is backed up every day. Restoring it rolls back '''everyone's''' servers, so it's only for disasters, not for undoing your own mistakes. Ask an infra admin if you need something from it.
| |
| : '''Per-server backups are coming soon.''' Until then, if you want your own restore point, use '''Backups → Take Backup''' (and/or a daily backup under '''Schedule'''), especially before risky changes.
| |
| | |
| ; Can I run something that isn't a game?
| |
| : '''Yes, run whatever you want''', no need to ask. Besides games, AMP has some non-game apps, and the ''Generic'' application lets you run pretty much any program as a managed server.
| |
| | |
| == See also ==
| |
| | |
| * [[AMP/Infrastructure]] – how the box is built and run (for infra admins)
| |
| * CubeCoders AMP docs: https://discourse.cubecoders.com/docs
| |
AMP is applicaton management panels for game servers like Minecraft, 7 Days to Die, Satisfactory, Valheim, Rust, Factorio, Terraria (Including tModLoader), Garry's Mod, many more games, and NodeJS and Python bots/applications
How to access?
It is hosted at http://amp.at.base48.cz/
Login using OIDC, your Base48 account
Panel and servers are accessible only on local network (for now).
Free to host anything you want, stop servers if not used for longer period of time. Delete if dead for a long time.
Backups are daily through proxmox lxc, setup your own local backups on schedule you need.
Managed by respi
