-
-
Notifications
You must be signed in to change notification settings - Fork 47
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add example docker compose and readme
- Loading branch information
Showing
3 changed files
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: |