Quick Start Guide
Get GPS Tools up and running in 10 minutes.
Prerequisites
Before you begin, ensure you have:
- ✅ Joomla 6.0 or later installed
- ✅ PHP 8.1 or later
- ✅ Modern browser (Chrome/Edge 90+, Firefox 88+, Safari 15+)
- ✅ A GPS track file (GPX, KML, or TCX) or be ready to draw a track
Step 1: Install GPS Tools
- Download
pkg_gpstools_x.x.x.zip - Go to System → Install → Extensions
- Upload and install the package
- You should see a success message
Step 2: Enable Plugins
- Go to System → Plugins
- Search for "gpstools"
- Enable the plugins:
- Content - GPS Tools (for shortcodes)
- Finder - GPS Tools (for search integration)
- System - GPS Tools (for enhanced processing)
- GPS Tools - Tracks (for track event handling)
Step 3: Create Your First Category
- Go to Components → GPS Tools → Categories
- Click New
- Enter a category name (e.g., "Hiking Trails")
- Click Save & Close
Step 4: Upload Your First Track
- Go to Components → GPS Tools → Tracks
- The React admin panel will load
- Click New Track button
- Fill in the details:
| Field | Value |
|---|---|
| Title | My First Trail |
| Category | Hiking Trails |
| Activity Type | Hiking |
| Difficulty | Easy |
- Choose your input method:
- Upload GPX/KML/TCX: Select a file from your GPS device or app
- Draw on Map: Click points on the interactive map to create a route
- Wait for parsing to complete
- Click Save
File Upload
The system automatically extracts coordinates, elevation, distance, and statistics from GPX, KML, and TCX files.
Drawing Tracks
When drawing tracks, the map will auto-calculate distance. Elevation data can be enriched after saving using external APIs.
Step 5: Create a Menu Item
- Go to Menus → Main Menu → Add New Menu Item
- Click Select for Menu Item Type
- Choose GPS Tools → Tracks List
- Enter a title: "Our Trails"
- Click Save & Close
Step 6: View on Your Site
- Go to your site's frontend
- Click on "Our Trails" in your menu
- You should see your track listing!
Click on a track to view:
- Interactive map with multiple tile providers
- Elevation profile chart
- Track statistics (distance, elevation gain/loss, speed)
- Photo gallery
- Comments and ratings
What's Next?
Configure Settings
Go to Components → GPS Tools → Options to configure:
- Map provider (OpenStreetMap or Google Maps)
- Map tile providers (15+ options)
- Unit system (Metric or Imperial)
- Chart display options
- Upload limits and access permissions
Add More Tracks
Upload GPX, KML, or TCX files from:
- GPS devices (Garmin, Suunto, Coros, etc.)
- Fitness apps (Strava, Komoot, AllTrails)
- Online sources
- Or draw tracks directly on the map!
Customize Display
- Modules - Add map widgets to any position
- Content Plugin - Embed tracks in articles
- Configuration - Full settings reference
Engage Your Community
Enable community features:
- Comments on tracks (nested replies)
- Like/dislike ratings
- Email notifications for subscribers
- Social sharing
Admin Dashboard
The React-powered admin panel provides:
- Track statistics overview
- Recent activity monitoring
- Quick access to all management features
- Bulk operations
Quick Reference
Shortcode for Articles
Display a track in any article:
{gpstools track="1"}
Common Settings Locations
| Setting | Location |
|---|---|
| Map Provider | Options → Map Settings |
| Unit System | Options → Display Settings |
| Permissions | Options → Permissions |
| Categories | GPS Tools → Categories |
| Track List | GPS Tools → Tracks |
Useful Menu Types
| Menu Type | Shows |
|---|---|
| Tracks List | All published tracks |
| Single Track | One specific track |
| Category Tracks | Tracks in a category |
Getting Help
If you run into issues:
- Check the Troubleshooting Guide
- Review the Configuration reference
- Ensure plugins are enabled
- Clear Joomla and browser cache
Congratulations! You've successfully set up GPS Tools. Explore the documentation to learn about advanced features like custom waypoints, module configuration, and API integration.