Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naamloos/mangotango
A simple web panel for Minecraft servers using Geyser+Floodgate to handle whitelist requests for both Java and Bedrock players.
https://github.com/naamloos/mangotango
asp-net-core floodgate geyser geysermc hacktoberfest minecraft react whitelist
Last synced: about 1 month ago
JSON representation
A simple web panel for Minecraft servers using Geyser+Floodgate to handle whitelist requests for both Java and Bedrock players.
- Host: GitHub
- URL: https://github.com/naamloos/mangotango
- Owner: Naamloos
- License: gpl-3.0
- Created: 2022-10-19T22:36:10.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-26T21:58:10.000Z (about 2 years ago)
- Last Synced: 2024-05-01T15:36:58.196Z (8 months ago)
- Topics: asp-net-core, floodgate, geyser, geysermc, hacktoberfest, minecraft, react, whitelist
- Language: C#
- Homepage:
- Size: 513 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 😸 MangoTango
A simple web panel for Minecraft servers using Geyser+Floodgate to handle whitelist requests for both Java and Bedrock players.
This application was initially written in about half a day.
This application is called after my Minecraft server that is as well called MangoTango. That server is named after one of my cats though 🙂
[Support Discord `#mangotango`](https://discord.gg/hMRWUTa)
## 🛠️ Setup
MangoTango requires some setup to get working properly. As of right now, I only _officially_ support docker-compose setups. The application _should_ work outside of docker as well.
1. Clone this repository with `git clone https://github.com/Naamloos/MangoTango`.
2. `cd MangoTango`
3. Edit `docker-compose.yml`. All values you'll most likely want to modify have a comment reading `CHANGEME`
4. Open the Frontend directory (`cd Frontend`) and modify all values in `.env`
5. Go back up one directory (`cd ../`)
6. Run docker compose `docker compose up --detach`
7. Your web services should now be up and running. We still need to do a bit more though.
8. Give internet access to the API. `docker network connect bridge mangotango-mangotango-api`
9. Done! You should be up and running. You can for example use NGINX to reverse proxy to `mangotango-api` for the api and `mangotango-web` for the web panel.
MangoTango does _not_ provide any prebuilt images, due to react injecting environment variables in the build step. Providing prebuilt images would remove the customizability of the front end.
### ❗ Bedrock XUID resolver fallback
The API provided by GeyserMC for resolving XUIDs does not always provide an answer for every xuid. To ensure MangoTango keeps working, an alternative API is provided to resolve XUIDs. If your bedrock players can't send requests, try setting the following environment variable in your `docker-compose.json`.
```
- OPENXBL_KEY=your_key_here
```
This key can be obtained at the following website: [OpenXBL](https://xbl.io)
### ❓ Example NGINX configuration
Do take note that it is generally not a good idea to host your services behind port 80! Make sure to either serve your site over HTTPS or have cloudflare as a proxy.
```nginx
server
{
listen 80;
server_name whitelist.example.org;
location /
{
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://mangotango-web:3000;
}
}
server
{
listen 80;
server_name whitelist-api.example.org;
location /
{
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://mangotango-api;
}
underscores_in_headers on;
}
```
### ❓ Example NGINX configuration using subpaths
Do make sure to correctly set the `PUBLIC_URL` env variable for the front end, and the `BASE_URI` environment variable for the back end and again, it is probably a good idea to serve your pages over HTTPS 🙂
```nginx
server
{
listen 80;
server_name whitelist.example.org;
location /whitelist/api/
{
rewrite ^/whitelist/api/(.*)$ /$1 break;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://mangotango-api;
}
location /whitelist/
{
rewrite ^/whitelist/(.*)$ /$1 break;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $http_host;
proxy_pass http://mangotango-web:3000;
}
}
```
#### ⚠️ NGINX note!
MangoTango uses a header named `rcon_password` to authenticate!
NGINX does not allow underscores in headers by default, so you will have to add `underscores_in_headers on;` to your NGINX server declaration.
Example can be seen in the example NGINX config above.
## 📸 Screenshots (as of the 20th of October, 2022)
### Unauthenticated view
### Client-side form validation
### After Authentication, requests appear under the form
### In-game notifications
