https://github.com/FriendsOfFlarum/geoip
Geolocation for your Flarum forum
https://github.com/FriendsOfFlarum/geoip
flarum friendsofflarum hacktoberfest
Last synced: 21 days ago
JSON representation
Geolocation for your Flarum forum
- Host: GitHub
- URL: https://github.com/FriendsOfFlarum/geoip
- Owner: FriendsOfFlarum
- License: mit
- Created: 2019-09-28T21:11:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-20T08:10:18.000Z (6 months ago)
- Last Synced: 2024-10-29T22:37:24.204Z (6 months ago)
- Topics: flarum, friendsofflarum, hacktoberfest
- Language: PHP
- Size: 829 KB
- Stars: 6
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-flarum - FoF GeoIP - Geolocation for your Flarum forum. (Extensions / Others ([:top:](#table-of-contents)))
README
# GeoIP by FriendsOfFlarum
 [](https://packagist.org/packages/fof/geoip) [](https://opencollective.com/fof/donate) [](https://datitisev.me/donate)
A [Flarum](http://flarum.org) extension.
## Empower Your Flarum Moderators with GeoIP
Moderators play a crucial role in maintaining the health and quality of forums. With GeoIP, give them the geolocation tools they need to better understand users, make informed decisions, and maintain a safe environment. Only moderators have access to IP-based geolocation, ensuring user privacy and data security.
### 🌎 Key Features
- **Location Insights**: Enable moderators to identify the country and region of users.
- **Interactive Mapping**: Let moderators visualize user locations with an integrated map view.
- **Threat Detection**: Equip moderators with the ability to highlight potentially malicious IP addresses through threat level indicators. (Via supported IP location data providers)
### Screenshots
##### Redesigned meta info (visible to admins/mods)
##### Integration with session management (visible to own profile)
##### Information modal with location map
### CLI Usage
The following CLI commands are provided:
#### `lookup`
Although IP addresses will be looked up when they are requested, this command will lookup all IP's that do not already have an entry in the `ip_info` table, using the currently selected provider.
```sh
php flarum fof:geoip:lookup
```
#### `lookup --force`
You may also force a refresh of IP data using the currently selected provider.
```sh
php flarum fof:geoip:lookup --force
```
### Queue offloading
The IP lookup can be time consuming, so the lookup of an unknown IP address is dispatched in a job, if you have a queue running this will run on a worker thread, rather than the main thread.
All IP address lookup jobs are dispatched to the `default` queue by default. If you have multiple queues, you can specify which queue to use for these jobs in your `extend.php`:
```
FoF\GeoIP\Jobs\RetrieveIP::$onQueue = 'my-other-queue';
```
### Installation
Install manually with composer:
```sh
composer require fof/geoip:"*"
```
### Updating
```sh
composer update fof/geoip
php flarum cache:clear
```
### Links
[](https://opencollective.com/fof/donate) [](https://datitisev.me/donate/github)
- [Packagist](https://packagist.org/packages/fof/geoip)
- [GitHub](https://github.com/FriendsOfFlarum/geoip)
An extension by [FriendsOfFlarum](https://github.com/FriendsOfFlarum).