================================================================
 GalaxyTracer Wireshark Plugin
 galaxytracer.io
================================================================

WHAT THIS DOES
--------------
Adds a "Send to GalaxyTracer" item to Wireshark's Tools menu.
With one click it sends your current capture to GalaxyTracer,
opening it in your browser for 3D network topology analysis.


REQUIREMENTS
------------
  - Wireshark 4.x or later
  - Python 3   (preinstalled on macOS and most Linux distros)
  - curl       (preinstalled on macOS and most Linux distros)

Tested on macOS Sonoma and Kali Linux 2024.1.
This plugin supports macOS and Linux. Windows is not currently
supported, but support is coming soon.


INSTALLATION
------------
1. Locate your Wireshark plugins directory. It is the same
   path on both macOS and Linux:

       ~/.local/lib/wireshark/plugins/

2. Create the directory if needed and copy the plugin into it.
   In a terminal:

       mkdir -p ~/.local/lib/wireshark/plugins/
       cp galaxytracer.lua ~/.local/lib/wireshark/plugins/

3. Fully quit and restart Wireshark. Wireshark loads Lua
   plugins only at startup, so a restart is required - closing
   and reopening the window is not enough.


USAGE
-----
1. Open a capture file in Wireshark, or capture live traffic.
2. Click:  Tools  >  Send to GalaxyTracer
3. Your browser opens with the capture loaded in GalaxyTracer.


TROUBLESHOOTING
---------------
"Send to GalaxyTracer" does not appear in the Tools menu:
  - Confirm galaxytracer.lua is in the plugins directory above.
  - Confirm you fully restarted Wireshark, not just the window.
  - Verify the plugin path under:
        Help > About Wireshark > Folders

The browser does not open after clicking the menu item:
  - Confirm Python 3 is installed:   python3 --version
  - Confirm curl is installed:       curl --version
  - Check /tmp/gt_upload.log for the error returned by curl.

Nothing happens and there is no error:
  - On minimal Linux installs, no default browser may be set.
    Set one, for example:
        xdg-settings set default-web-browser firefox.desktop


PRIVACY
-------
When you send a capture, packet metadata is uploaded to
GalaxyTracer to generate a shareable link. Shared captures are
automatically deleted after 30 days. Only send captures you are
comfortable sharing.


================================================================
 GalaxyTracer - galaxytracer.io
================================================================
