FelisMC/Felis

0 Fork 0

Files

T

Lemon-miaow 62c5a8a408 docs(readme): port the private-repo install path and upgrade notes to the English README (#66 )

README.md grew a required workaround — the repository is private, so the
plain raw.githubusercontent one-liner returns 404.  The credentialed form
(token handed to curl via --config - so it never touches argv, sudo -E so
the installer inherits it) and the rerun/upgrade notes (the rerun upgrades
felis-api; the channel is not inherited, so main-followers need
FELIS_VERSION_BOOTSTRAP=dev) never made it into README_EN.md, which is
linked as the English entry point.  An English reader following that page
could not install at all.  Bring it back in sync with the Chinese one.

2026-09-24 01:24:27 +08:00

4.7 KiB

Raw Blame History

Felis

A Kubernetes-driven Minecraft server hosting platform — one command to deploy, automatic lifecycle, backup, and security.
一款 Kubernetes 驱动的 Minecraft 服务器托管平台，一行命令部署，自动管理生命周期与安全。

简体中文 | English

Table of Contents

Features
Getting Started
Build from Source
License
Acknowledgements

Features

Wake on Join: Servers start automatically when a player connects, and stop when idle — like hibernate for your server.
Web Dashboard: Monitor server status, online players, and resource usage from your browser, with backup and restore management.
Backup & Restore: One-click snapshots of a server's whole data volume (worlds, config, plugins/mods — the entire /data volume) into the cluster's archive store, with rollback from any backup point — enabled by default (the installer renders the archive PVC and its path).
World Reaper (opt in): Worlds idle for more than 15 days are automatically backed up and removed to free disk space. Enable it by setting FELIS_WORLDS_HOST_PATH at install time (on k3s: /var/lib/rancher/k3s/storage); without it, no world is ever deleted.
Multi-core Support: Compatible with Paper, Fabric, Forge, and NeoForge, federated behind a Velocity proxy.
Modpack Submission: Players submit custom modpacks; admin approval triggers automatic build and deployment.
Passkey Login: Passwordless authentication via fingerprint, face recognition, or hardware security keys.
Zero Trust Security: Panel traffic protected by Cloudflare Access; the internal API is never exposed to the internet.

Getting Started

On a prepared Linux host, run:

curl -fsSL https://raw.githubusercontent.com/FelisMC/Felis/main/deploy/bootstrap.sh | sudo bash

The script installs K3s, deploys the control plane, and launches a setup wizard. Once done, open your browser at the configured domain.

This repository is currently private, so the command above returns 404. Use the credentialed form instead; the installer itself needs the same token to resolve and download the release, so pass it through with sudo -E:
export FELIS_GITHUB_TOKEN=<a token with read access to this repository>
printf 'header = "Authorization: Bearer %s"\n' "$FELIS_GITHUB_TOKEN" \
  | curl -fsSL --config - -H "Accept: application/vnd.github.raw" \
      https://api.github.com/repos/FelisMC/Felis/contents/deploy/bootstrap.sh \
  | sudo -E bash
The token reaches curl --config - over stdin instead of the command line: argv is readable by any local user via /proc, and that is exactly why the installer's internal github_api uses the same form.

Rerunning this command is also how you upgrade felis-api to a newer version (felis setup cannot — it uses the binary already installed on the host). The rerun keeps the installed root domain but not the channel: if this host follows main, also export FELIS_VERSION_BOOTSTRAP=dev.

Build from Source

Felis is built with Go and Node.js:

# Backend (Go 1.26+)
go build -o felis ./cmd/felis

# Frontend (Node.js 22+)
cd panel
npm ci
npm run build

# Docker image
docker build -t felis:custom .

License

The source code is released under AGPL-3.0-only.

License Notes

Derivative works are AGPL too: Any distribution of this project or of software derived from it must be released under AGPL-3.0 and must include the original copyright notice and license statement.
Running it as a network service also triggers the source obligation (AGPL section 13): if you host a modified Felis for other people to use, you must offer those users the complete source of your modified version — even if you never distribute a binary. This is the one substantive difference between AGPL and GPL, and since Felis is a hosting platform reached over a network, it will essentially always apply.
Disclaimer: This project is provided "as is", without warranty of any kind.

Acknowledgements

Kubernetes: Container orchestration engine
K3s: Lightweight Kubernetes distribution
Cloudflare Zero Trust: Zero trust security infrastructure
PostgreSQL: Data persistence
React: User interface framework
Vite: Frontend build tool
TailwindCSS: CSS framework
Bubble Tea: TUI framework
Minecraft: What makes this all worthwhile

4.7 KiB Raw Blame History