Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 2.4 KB

File metadata and controls

69 lines (48 loc) · 2.4 KB
Continuous Integration Status Documentation Status

Serveradmin

Serveradmin is central server database management system of InnoGames. It has a HTTP web interface and a HTTP JSON API. Check out the documentation or watch this FOSDEM 19 talk for a deepdive how InnoGames works with serveradmin.

Quickstart

The fastest way to get a local Serveradmin running is the provided Docker Compose setup. It starts the web application together with a PostgreSQL database, installs all dependencies, applies the database schema and creates a default user - no local Python or PostgreSQL installation required.

Note

This setup is meant for local development and evaluation, not production.

You need:

Get it running:

git clone https://github.com/innogames/serveradmin
cd serveradmin
cp .env.dist .env
docker compose up

The defaults in .env.dist work out of the box; adjust them later if needed. On the first start the containers install the dependencies, run the database migrations and create a default super user, then start the development server.

Once it is ready, open http://127.0.0.1:8000 and log in with the default credentials serveradmin / serveradmin.

To run management commands or the Python Remote API, open a shell in the running web container:

docker compose exec web bash

# Django management commands
uv run python -m serveradmin -h

# Python Remote API
uv run python -m adminapi "hostname=example.com"

See the documentation for configuration, development and extension topics.

License

The project is released under the MIT License. The MIT License is registered with and approved by the Open Source Initiative.