Skip to documentation

Bedrock Server Manager

Start here

What BSM manages
- Find the right guide
First startup
- Create your first server
- Make startup persistent
Upgrade an installation
Install Bedrock Server Manager
Command-line tools
Use the web interface
- Manage a server
- Manage the installation
Accounts, roles and access
Troubleshooting

Manage servers

Install and update game servers
Manage running servers
Configure a Bedrock server
Back up and restore a server
Schedule automated tasks
Worlds and addons
Application settings and storage
Bundled plugins

CLI Commands

Local CLI Commands
- bedrock-server-manager
  - backup
    - extract
    - inspect
  - cleanup
  - database
    - backup
    - downgrade
    - restore
    - status
    - upgrade
  - logs
  - reset-mfa
  - reset-password
  - service
    - configure
    - disable
    - enable
    - remove
    - status
  - setup
  - web
    - start
    - stop
API Client Commands
- bsm-cli
  - account
  - addon
    - install
    - manage
  - allowlist
    - add
    - list
    - remove
  - api
    - call
    - diff
    - download
    - export
    - info
    - operation
    - operations
    - refresh
    - schema
  - appearance
    - set
    - show
  - audit
  - auth
    - login
    - logout
    - setup
  - backup
    - create
    - prune
    - restore
  - bans
    - add
    - list
    - remove
  - content
    - upload
  - diagnostics
    - compare
    - history
    - report
    - runs
    - snapshot
    - trace
  - events
    - activity
    - catalog
  - health
  - logs
  - monitor
  - overview
  - permissions
    - list
    - set
  - player
    - add
    - scan
  - plugin
    - call
    - disable
    - enable
    - list
    - operations
    - reload
    - settings
    - trigger-event
  - properties
    - get
    - raw
    - set
  - runtime
  - server
    - delete
    - install
    - list
    - monitor
    - restart
    - send-command
    - settings
    - start
    - stop
    - update
  - settings
  - shutdown
  - tasks
    - list
    - show
  - users
    - delete
    - disable
    - enable
    - invite
    - list
    - set-role
  - world
    - export
    - install
    - reset

Administration and integrations

Run BSM in Docker
- Persist configuration and data
- Stop, upgrade, and run local recovery commands
HTTP API and clients
Place content files manually
Hosting and web customization
Real-time WebSockets and log streaming
Web runtime and graceful shutdown
Diagnostics and support reports
Theming

Changelog

Changelog

Use and develop plugins

Install and manage plugins
Write a plugin
Calling the plugin API
Available plugin APIs
Available plugin events
Plugin Base
- PluginBase
Plugin Manager
- PluginManager
Custom events and cancellation
Plugin Settings and Storage
Scheduled tasks in plugins
Custom FastAPI endpoints
- Static asset mounts (static_mounts)
- Router resources
Native JSON UI for Plugins
Background tasks

Backend contributors and Python reference

Backend architecture and documentation
- Choose a boundary
- Maintain documentation
Contributor setup and validation
- Checks
Event architecture
State, storage and service mutations
- Mutation boundaries
- Database evolution
Diagnostics and health architecture
- Collection contracts
- Persistence and privacy
Runtime ownership and cleanup
- Lifespan and shutdown
- Embedding and tests
Adding an API contract
- Requests, results and errors
- HTTP and consumer changes
Web composition and package boundaries
HTTP permissions and browser authentication
API Documentation
Core Class Documentation
Core Documentation

Subsystem references

Events
Diagnostics and health
Application state
Application services
Storage and repositories
Web runtime
Request and response models
Server components
Backups
Scheduler
Plugins Internals
Utilities

Bedrock Server Manager

BSM / Documentation

Mode Density

Events
control
View page source

control

Cancellation is mutable only while before-operation listeners are running.

Previous Next

Built with Sphinx using a theme provided by Read the Docs.