https://github.com/warningimhack3r/mintstone
[WIP - Paused] Comprehensive web admin panel for self-hosted Minecraft servers
https://github.com/warningimhack3r/mintstone
administration java minecraft minecraft-server svelte
Last synced: 11 months ago
JSON representation
[WIP - Paused] Comprehensive web admin panel for self-hosted Minecraft servers
- Host: GitHub
- URL: https://github.com/warningimhack3r/mintstone
- Owner: WarningImHack3r
- License: mit
- Created: 2023-07-15T22:07:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T20:04:49.000Z (over 1 year ago)
- Last Synced: 2024-10-29T22:40:49.641Z (over 1 year ago)
- Topics: administration, java, minecraft, minecraft-server, svelte
- Language: Svelte
- Homepage:
- Size: 574 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mintstone
Comprehensive web admin panel for self-hosted Minecraft servers. Supports all servers since Minecraft [Beta 1.9-pre4](https://minecraft.wiki/Java_Edition_Beta_1.9_Prerelease_4) (2011/10).
## Features
- Server management
- Support for multiple servers
- Server updates monitoring and notifications
- ...and more!
## Planned Features
- Authentication
- Server monitoring
- Plugin monitoring
- Support for all server types (Vanilla, Spigot, Paper, etc.)
You can see the full list of planned features [in the Projects tab](https://github.com/WarningImHack3r/Mintstone/projects).
## Setup
### Configuring your Minecraft server
Edit your `server.properties` by changing the following values:
```properties
# Enable most of the features
enable-rcon=true
# Set any password you want but set one. If you don't, the server will automatically disable RCON
rcon.password=
# Change it or leave it as is, but make sure it's not the same as your server port and note it down
# Note: don't forget to open this port in your firewall if you want to access it from outside your network
rcon.port=
# Enable monitoring features
enable-jmx-monitoring=true
```
Then restart your server.
### Installing Mintstone
#### Docker (recommended)
1. Make sure you have [Docker](https://www.docker.com) installed.
2. Create the container with the following command:
```sh
docker run -d \
--name mintstone \
-p 8080:8080 \
-p 3000:3000 \
ghcr.io/warningimhack3r/mintstone
```
> `8080:8080` needs to be exposed in order for Mintstone to work. `3000:3000` is also required, although it can be changed to any other port (`1234:3000` to use port 1234, for example).
3. Open `http://localhost:3000` in your browser.
#### Manual (Docker Compose)
1. Make sure you have [Docker](https://www.docker.com) and [Docker Compose](https://docs.docker.com/compose) installed.
2. Clone this repository.
3. Run `docker-compose up` in the root directory.
4. Open `http://localhost:3000` in your browser.
#### Manual
1. Make sure you have [Node.js](https://nodejs.org) (v16+), [PNPM](https://pnpm.io), and [Java](https://www.java.com) installed.
2. Clone this repository.
3. Run `./gradlew bootRun` (or `gradlew.bat bootRun` on Windows) in the `backend` directory.
4. Run `pnpm install` in the `frontend` directory.
5. Run `pnpm build` in the `frontend` directory.
6. Run `pnpm start` in the `frontend` directory.
7. Open `http://localhost:3000` in your browser.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
---
> Entirely and proudly written with the [Monocraft](https://github.com/IdreesInc/Monocraft) font!