Skip to content

Kalletal/MineOS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MineOS-DSM

MineOS adaptation for Synology DiskStation Manager (DSM) 7.x

Overview

This project adapts MineOS-node, a web-based Minecraft server management interface, to run as a Synology SPK package on DSM 7.x systems.

Target Platform: Synology DS920+ (geminilake architecture) running DSM 7.2

Features

  • 📦 Easy Installation: Install via DSM Package Center
  • 🔐 DSM Authentication: Login with your existing DSM credentials
  • 🎮 Multi-Server Management: Create and manage multiple Minecraft servers
  • 💾 Automated Backups: Schedule backups and restore from previous points
  • 📊 Real-time Monitoring: View server status, console output, and resource usage
  • 🔄 Seamless Upgrades: Update without losing your server data
  • 🔒 Secure: Runs as non-privileged user, isolated from system

Project Status

🎯 MVP Complete (100%) - Ready for testing on physical NAS

  • ✅ Phase 1: Setup (100%)
  • ✅ Phase 2: Foundational (83%)
  • ✅ Phase 3: User Story 1 - Installation & Authentication (100%)
  • 📦 SPK Package: MineOS_geminilake-dsm70_20251116_v2.spk (43 MB)
  • 📊 Overall Progress: 57/264 tasks (21.6%)

Next Steps: Install and test on DS920+ with DSM 7.2, then continue with User Story 2 (Server Management)

Documentation

User Guides

Technical Documentation

Session Notes

Quick Start

Démarrage Rapide Interactif

# Clone repository avec submodules
git clone --recursive <repo-url>
cd Mineos

# Lancer le guide interactif
./quickstart.sh

Le script quickstart.sh vous guidera à travers:

  1. Vérification de l'environnement (Docker, Git, etc.)
  2. Sélection de l'architecture cible
  3. Construction du package SPK
  4. Déploiement sur votre NAS

Build Manuel

# Vérifier l'environnement
./scripts/check-build-env.sh

# Build pour DS920+ (geminilake)
./build-spk.sh

# Ou pour une autre architecture
./build-spk.sh apollolake 7.0

# Le package sera créé: MineOS_[arch]-dsm[version]_[date].spk

Installation sur le NAS

Via DSM Package Center:

  1. Transférez le fichier .spk sur votre ordinateur
  2. DSM → Centre de paquets → Installation manuelle
  3. Sélectionnez le fichier SPK

Via SSH:

scp MineOS_*.spk admin@your-nas-ip:/tmp/
ssh admin@your-nas-ip
sudo synopkg install /tmp/MineOS_*.spk
sudo synopkg start MineOS

Accès:

https://your-nas-ip:8443

Project Structure

.
├── spk/                    # SPK package structure
│   ├── INFO                # Package metadata
│   ├── scripts/            # Installation/service scripts
│   ├── conf/               # Configuration templates
│   └── ui/                 # Package Center UI
├── mineos-node/            # MineOS-node upstream (submodule)
│   └── dsm-patches/        # DSM-specific adaptations
├── build/                  # Build infrastructure
│   └── spksrc/             # spksrc framework (submodule)
├── tests/                  # Integration and manual tests
├── docs/                   # User and developer documentation
└── specs/                  # Design documents and tasks

Requirements

Runtime (on NAS)

  • Synology NAS with DSM 7.0 or higher
  • x86_64 architecture (DS920+, DS918+, etc.)
  • At least 4GB RAM (8GB recommended)
  • Java 8+ (available via DSM Package Center)

Development

  • Linux, macOS, or WSL2
  • Docker (for building SPK)
  • Git
  • SSH access to test NAS

Status

🚧 In Development - See tasks.md for progress

Completed:

  • ✅ Phase 1: Setup and directory structure
  • ✅ Phase 2: Foundational infrastructure (SPK scripts, DSM patches, config loaders)
  • ✅ Phase 3: User Story 1 - Integration and build system (DSM auth, paths, build configuration)
  • ✅ Build automation (scripts, Docker integration, multi-arch support)
  • ✅ Complete documentation (installation, build, architecture, tests)

Current Phase: Ready for build and testing Next Steps:

  1. Build SPK package with Docker (./build-spk.sh)
  2. Test installation on DS920+ DSM 7.2
  3. Implement server management features (Phase 4)

License

GPL-3.0 (inherited from MineOS-node)

Credits

Support

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages