[Feature]: LGSM command for restoring backups

Open
#4,507 1 comment 4 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
bash, shell
Domain
cli, devops

Research direction

Start at the ./gameserver command entry point and trace the existing backup command and backup layout. Define how interactive, latest, and named restores should select archives, replace the installation, and handle LGSM itself. Done means all three invocation forms restore the selected backup without leaving files that were absent from it.

Written by the indexing model from the issue text.

Description

command: backup command: install type: feature
User story

As a server admin, I want LinuxGSM to handle backup restoration for me to minimize the downtime and work needed when restoring backups.

Game

All

Linux distro

Other

Command

command: backup

Further information

The command would use automatically or manually created backups to quickly restore the gameserver to a specific point in time by overwriting the backed up files. To avoid problems caused by newly created files that don't exist in a backup (such as new saves or player profiles), the entire installation should be deleted and replaced with the contents of the backup.

Restore a backup (prompt the user by listing all existing backups):
./gameserver restore-backup

Restore the latest backup:
./gameserver restore-backup latest

Restore a specific backup:
./gameserver restore-backup "gameserver-2024-02-05-040000.tar.gz"

Possible Problems:

  • Replacing LGSM from within LGSM may prove difficult.
    • Skipping the restoration of LGSM however could lead to incompatibilities between gameserver and LGSM

A future implementation of this/another command could also be useful for automatically applying manually created "backups" that have been prepared to introduce changes to game configurations, maps, mods or rules by overwriting only certain files. However, this will require a completely new backup procedure, as regular restoring of a backup will need to deal with unwanted files not included in the backup as listed above.

Restore a manually prepared "backup":
./gameserver restore-backup "special-event.tar.gz"

Dominant language
Shell
Stars
4.9k
Forks
866
Avg merge
17h 58m
Merged PRs (30d)
100

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from GameServerManagers/LinuxGSM

All issues in GameServerManagers/LinuxGSM

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.