📦 Installation Guide

Step-by-step instructions to install Q2G in QGIS

System Requirements

  • QGIS: Version 3.4 or higher
  • GeoServer: Version 2.19 or higher
  • Python: 3.6+ (included with QGIS)
  • Operating System: Windows, macOS, or Linux
  • Internet Connection: Required for Q2G communication
  • Disk Space: ~50 MB for plugin and temporary files

Installation Methods

Method 1: QGIS Plugin Manager (Recommended)

This is the easiest and recommended way to install Q2G:

Step 1: Open QGIS and go to Plugins → Manage and Install Plugins...
Step 2: In the Plugin Manager window, search for "Q2G"
Step 3: Click on the Q2G result to view details
Step 4: Click the Install Plugin button
Step 5: Wait for the installation to complete. You'll see a confirmation message.
Step 6: Close the Plugin Manager. The plugin is now installed!
Note: The plugin will appear in the QGIS interface. You may need to restart QGIS to see it fully loaded.

Method 2: Manual Installation

If you have a plugin package file or want to install from source:

Windows

  1. Locate your QGIS plugins directory: 
    C:\Users\[YourUsername]\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins
  2. Extract the Q2G plugin folder into this directory
  3. Restart QGIS
  4. Go to Plugins → Manage and Install Plugins
  5. Search for "Q2G" and enable it

macOS

  1. Locate your QGIS plugins directory: 
    ~/Library/Application Support/QGIS/QGIS3/profiles/default/python/plugins
  2. Extract the Q2G plugin folder into this directory
  3. Restart QGIS
  4. Go to Plugins → Manage and Install Plugins
  5. Search for "Q2G" and enable it

Linux

  1. Locate your QGIS plugins directory: 
    ~/.local/share/QGIS/QGIS3/profiles/default/python/plugins
  2. Extract the Q2G plugin folder into this directory
  3. Restart QGIS
  4. Go to Plugins → Manage and Install Plugins
  5. Search for "Q2G" and enable it

Verifying Installation

After installation, verify that Q2G is properly installed:

Check Plugin Manager

  1. Open QGIS
  2. Go to Plugins → Manage and Install Plugins
  3. Look for "Q2G" in the list
  4. Ensure the checkbox next to it is checked (enabled)

Check Plugin Menu

  1. Look for "Q2G" in the main QGIS menu bar
  2. Or check the Plugins menu for a Q2G submenu

Check Toolbars

  1. Look for the Q2G toolbar (usually shows a GeoServer icon)
  2. You should see buttons for opening the plugin interface
Success! If you can see the plugin in the menu or toolbar, installation was successful.

Troubleshooting Installation

Plugin doesn't appear after installation

  • Restart QGIS completely
  • Check if the plugin is enabled in Plugin Manager
  • Look in the QGIS log file for any error messages

Installation fails with permission error

  • Run QGIS as Administrator (Windows)
  • Check folder permissions in your plugins directory
  • Try manual installation instead

Plugin crashes on startup

  • Check QGIS version compatibility (must be 3.4+)
  • Reinstall the plugin
  • Check the QGIS log file for error details

Cannot find plugin in Plugin Manager

  • Ensure you have internet connection
  • Try refreshing the plugin list
  • Check if your QGIS version is supported

Updating the Plugin

To update Q2G to the latest version:

  1. Open QGIS
  2. Go to Plugins → Manage and Install Plugins
  3. Click on the "Updates" tab
  4. Look for "Q2G" in the list
  5. Click Upgrade Plugin
  6. Restart QGIS
Tip: Enable automatic updates in Plugin Manager settings to stay up-to-date.

Uninstalling the Plugin

If you need to remove Q2G:

  1. Open QGIS
  2. Go to Plugins → Manage and Install Plugins
  3. Search for "Q2G"
  4. Click Uninstall Plugin
  5. Confirm the uninstallation
  6. Restart QGIS

Dependencies

Q2G requires the following Python packages (usually included with QGIS):

  • requests - HTTP library for API communication
  • PyQt5 - GUI framework (included with QGIS)
  • qgis.core - QGIS core library
Note: These dependencies are typically pre-installed with QGIS and don't require manual installation.

Next Steps

Now that you have installed Q2G, proceed to:

↑