Skip to content

Commit

Permalink
Add example docker compose and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
rtm516 committed Jun 30, 2024
1 parent a11e3dc commit c621e81
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![HitCount](https://hits.dwyl.com/rtm516/MCXboxBroadcast.svg?style=flat)](http://hits.dwyl.com/rtm516/MCXboxBroadcast)
[![Discord](https://img.shields.io/discord/1139621390908133396?label=discord&color=5865F2)](https://discord.gg/Tp3tA2kdCN)

A simple [Geyser](https://github.com/GeyserMC/Geyser) extension that broadcasts the server over Xbox Live.
A simple tool that broadcasts an existing [Geyser](https://github.com/GeyserMC/Geyser)/Bedrock server over Xbox Live.

This shows up to the authenticated accounts friends in-game as a joinable session and then anyone thats friends with someone who joined through that method will also see the session as joinable ingame.

Expand All @@ -19,6 +19,7 @@ You use this project at your own risk, the contributors are not responsible for
- Easy Geyser integration (as an extension)
- Shows as online and playing Minecraft in the Xbox app and website
- Multi-account support
- Web manager for larger networks

## Pterodactyl Panel
There is an egg for easy instance creation supplied for [Pterodactyl Panel](https://pterodactyl.io/), this being `egg-m-c-xbox-broadcast.json`
Expand Down Expand Up @@ -52,6 +53,8 @@ docker run --rm -it -v /path/to/config:/opt/app/config ghcr.io/rtm516/mcxboxbroa
6. Follow the account on Xbox LIVE
7. Check the friends tab ingame and you should see the server listed

### Manager
See [manager readme](bootstrap/manager/README.md)

## Commands
For the extension version prefix with `/mcxboxbroadcast`
Expand Down
21 changes: 21 additions & 0 deletions bootstrap/manager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# MCXboxBroadcast Manager
This is the manager for the MCXboxBroadcast project, it is used to manage the accounts and the server details that are broadcasted through a web page.

The manager is designed for bigger deployments and not recommended for smaller ones as it requires a MongoDB instance to store the data.

## Installation
1. Download the latest release file `MCXboxBroadcastManager.jar`
2. Set the `SPRING_DATA_MONGODB_URI` environment variable to the MongoDB connection string
3. Start the jar file using `java -jar MCXboxBroadcastManager.jar`
4. Open the web page, port 8082 by default
5. Login with the default credentials `admin:password`

## Docker
The image can be found at `ghcr.io/rtm516/mcxboxbroadcast-manager:latest`

There is also a prebuilt Docker compose file that can be used to run the manager and the mongodb together. This can be found at [`docker-compose.yml`](docker-compose.yml)

## Additional Configuration
Configuration can be made in the `application.yml` mounted into `/opt/app/config` (supports a range of spring properties)

Theres also an environment variable `SECURE` that if set to `false` it will disable the login requirement
21 changes: 21 additions & 0 deletions bootstrap/manager/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: mcxbmanager

services:
manager:
image: ghcr.io/rtm516/mcxboxbroadcast-manager:latest
ports:
- "8082:8082"
volumes:
- /path/to/config/:/opt/app/config/
depends_on:
- mongo
environment:
- SPRING_DATA_MONGODB_URI=mongodb://mongo:27017/mcxboxbroadcast

mongo:
image: mongo:latest
volumes:
- mongo_data:/data/db

volumes:
mongo_data:

0 comments on commit c621e81

Please sign in to comment.