mumble-ping/README.md

29 lines
1.2 KiB
Markdown
Raw Permalink Normal View History

2023-07-22 18:51:57 +00:00
# Mumble ping API
A simple PHP module to ping mumble serbers.
## How to install
1. Run this thing: `git clone https://git.lolcat.ca/lolcat/mumble-ping/`
2. Download the latest release of geoip2.phar: https://github.com/maxmind/GeoIP2-php/releases
3. Sign up for maxmind's bullshit site and get the **country** GeoLite2 .mmdb file
4. Make sure curl is installed. `sudo apt install curl php-curl` should set everything up.
5. Drop all the shit you downloaded in the root of this repo
Now, just drop all of that crap inside a webserber that supports PHP and access the mumble.php file.
Don't forget to make mumble-scrape inaccessible!
To be able to show users the serber name and website, you need to scrape the official mumble serber list using mumble-scrape.php. This repo comes with a pre-compiled list.json, but it is probably outdated. Use `screen` and run mumble-scrape.php in the background. By default, it gets a list of all serbers every 24 hours and resolves the DNS for all domains!
## Usage
`/mumble.php?ip=lolcat.ca`
or
`/mumble.php?ip=skyn3t.in&port=64738`
or for banners: `/banner.php?ip=aaathats3as.com`
So yeah, the port is optional. IPs and port is sanitized.
## Try it out
https://lolcat.ca/mumble_ping_api/
Enjoy!!