Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 2.99 KB

README.md

File metadata and controls

51 lines (32 loc) · 2.99 KB
Raw

Public IP Address widget for KDE 6

Description

Plasma 6 widget for showing informations about your public IP address and the status of your VPN (active/inactive). This is useful for informational purposes and to monitor VPN geolocation.

The expanded view shows a map with informations requested from ipinfo.com: you can copy to clipboard the different informations by clicking over them. You can also open the map on the browser, and update the informations by sending another request.

By default, the widget update itself every 5 minutes. You can change this behaviour in the settings. Please note that ipinfo.com API limits the total amount of requests to 1000 per day: this means that the plugin will update itself at most every 2 minutes.

You can change the colors of the displayed informations in the settings.

This widget uses the excellent flags icon pack by lipis and contributors.

tooltip screenshot expanded screenshot

Master branch deals with Plasma 6. plasma5 branch contains the code for Plasma 5.

Dependencies

The primary functions of the widget (check IP address) should work correctly even if the following dependencies are not installed. Anyway, to get the best experience you need:

  • libnotify-bin: this is for showing notifications when clicking links, thus copying the link's content to the clipboard.
    sudo apt install libnotify-bin
  • nmcli: this is part of the network-manager package. It'll check the status of the VPN by executing the command nmcli c show --active; if a VPN is active, there should be some entries containing the keywords vpn or tun. It should already be installed in Ubuntu. Don't know about other distros (let me know in the comments or by opening an issue).
  • QtPositioning and QtLocation. In particular, for Ubuntu and:
    • Plasma 5: sudo apt-get install libqt5positioning5 libqt5location5 qtlocation5-dev qtpositioning5-dev qml-module-qtlocation qml-module-qtpositioning
    • Plasma 6: sudo apt-get install libqt6positioning6 libqt6location6 qml-module-qtlocation qml-module-qtpositioning

Installation

From openDesktop.org

  1. Go to Open Desktop, Plasma 5 or Plasma 6.
  2. Click on the Files tab
  3. Click the Install button

From within the Plasma workspace

  1. If your widgets are locked, right-click the desktop and select Unlock Widgets
  2. Right-click the desktop and select Add Widgets...
  3. Click the Get new widgets button in the Widget Explorer that just opened
  4. Type Public IP Address into the search field
  5. Click the Install button next to Public IP Address

FAQ

Can you add an option to use a different map provider other than OpenStreetMap?

No, because most other map providers require an API key, whereas OSM does not need it. This means everyone should be able to view the map.