/Katan

Katan is a fast, simple with high-availability game server management panel running isolated in Docker containers with a Web server built with Ktor.

Primary LanguageKotlinApache License 2.0Apache-2.0

Katan

Katan is a fast, simple with high-availability game server management panel running isolated in Docker containers with a Web server built with Ktor.

Open Source Stars Codacy Badge

Contents

Motivation

The initial motivation behind the creation of the Katan is partly for server handling panels to be paid for, licensed, and those that are not paid very poorly maintained with several basic problems that can be solved but there is no maintenance.

Katan combines a beautiful UI for clients in an excellent code base for the server with support for built-in plugins without the need for help from the creator, everyone can create and modify their own panels as they wish using the public API.

Performance

Built to be functional and fault-tolerant, completely asynchronous and multi-threaded that even low-powered machines will handle it, running servers in isolated Docker containers, in conjunction with Redis caching service.

Metrics

Katan Web Server has support for system metrics service using Prometheus, which absolutely no panel I used got support, you can enable in the settings if you have installed it on your machine.

Freedom

In Katan it is possible to change absolutely everything in your containers via API (directly) or through the CLI and configuration files, for example you can define a predefined docker-compose.yml file for composition and use it during creation of the servers.

Imagine you have a composition file named some-game, when using katan server create -c some-game you will create a server based on that file.

Features

Command Line Interface

Create and manage Katan servers, accounts, settings and status right from Katan's built-in command line interface.

Web server

If you are not familiar with the command line, we have the web server with a beautiful UI with the same functionality for those who prefer ease and simplicity.

Facility

Installing, configuring and running Katan is extremely easy and fast, by default it comes ready to use with all the necessary features and you can configure it to your liking and add new features such as metrics.

Modules

Name Description
api High-level public API used in all modules.
bootstrap The launcher, is the starting point of Katan responsible for starting the Core, CLI and WebServer.
cli Built-in command line interface (type "katan").
common Contains common code used in more than one module in the project.
docker-compose Add docker-compose support not provided by the Java Docker Client (used by Katan)
web-server Katan's web server, uses Ktor with which the Daemon interacts.

Community

Join our communities, discuss changes, discover news and things to come on Katan.