udiskie 0.6.4

Removable disk automounter for udisks

udiskie is a simple daemon that uses UDisks to automatically mount removable storage devices. This daemon comes with optional mount notifications and GTK tray icon. It also provides a user level CLI for mount and unmount operations.

Usage

Start the automount and notification daemon:

# the optional tray icon requires PyGTK
udiskie --tray

Mount or unlock a specific device manually:

udiskie-mount /dev/sdb1

Unmount or remove a specific device manually:

udiskie-umount /media/<device-name>

See the man page for further instructions

Dependencies

Unfortunately, udiskie has dependencies that can not be automatically downloaded and installed from PyPI:

• UDisks required for all operation modes. UDisks2 support is experimental and has to be requested explicitly via the command line parameter -2.

• dbus-python required for all operation modes

• PyGObject to run the automount/notification daemon (provides the main loop)

• notify2 or notify-python for mount notifications

• Zenity to show a password prompt to unlock LUKS devices

• PyGTK to show the system tray icon

Permissions

udiskie requires permission for the following PolicyKit actions:

• org.freedesktop.udisks.filesystem-mount for mounting and unmounting

• org.freedesktop.udisks.luks-unlock to unlock LUKS devices

• org.freedesktop.udisks.drive-eject to eject drives

• org.freedesktop.udisks.drive-detach to detach drives

These are usually granted when using a desktop environment. If your login session is not properly activated you may need to customize your PolicyKit settings. Create the file /etc/polkit-1/localauthority/50-local.d/10-udiskie.pkla with the following contents:

[udiskie]
Identity=unix-group:storage
Action=org.freedesktop.udisks.filesystem-mount;org.freedesktop.udisks.luks-unlock;org.freedesktop.udisks.drive-eject;org.freedesktop.udisks.drive-detach
ResultAny=yes

This configuration allows all members of the storage group to run udiskie.

Alternatively, change the setting for allow_inactive to yes in the file /usr/share/polkit-1/actions/org.freedesktop.udisks.policy:

<action id="org.freedesktop.udisks.filesystem-mount">
    ...
    <allow_inactive>yes</allow_inactive>
    ...
</action>

...

Do this for all relevant actions.

Note that UDisks2 uses another set of permissions, see /usr/share/polkit-1/actions/org.freedesktop.udisks2.policy.

GTK icons

udiskie comes with a set of themeable custom Tango-style GTK icons for its tray icon menu. The installer tries to install the icons into GTK’s default hicolor theme. Typically this is located in /usr/share/icons/hicolor. If you have any problems with this or you need a custom path you can manually do it like so:

cp ./icons/scalable /usr/share/icons/hicolor -r
gtk-update-icon-cache /usr/share/icons/hicolor

The icons roughly follow the Tango style guidelines. Some icons incorporate the CDROM icon of the base icon theme of the Tango desktop project (released into the public domain).

Contributing

udiskie is developed on github. Feel free to contribute patches as pull requests here.

Try to be consistent with the PEP8 guidelines. Add unit tests for all non-trivial functionality if possible. Dependency injection is a great pattern to keep modules flexible and testable.

Commits should be reversible, independent units if possible. Use descriptive titles and also add an explaining commit message unless the modification is trivial. See also: A Note About Git Commit Messages.

Contact

You can use the github issues to report any issues you encounter, ask general questions or suggest new features. There is also a public mailing list on sourceforge if you prefer email.

CHANGELOG

0.6.4

• fix logging in setup.py

• more verbose log messages (with time) when having -v on

• fix mounting devices that are added as ‘external’ and later changed to ‘internal’ [udisks1] (applies to LUKS devices that are opened by an udev rule for example)

0.6.3 (bug fix)

• fix exception in Mounter.detach_device if unable to detach

• fix force-detach for UDisks2 backend

• automatically use UDisks2 if UDisks1 is not available

• mount unlocked devices only once, removes error message on UDisks2

• mention __ignore__ in man page

0.6.2 (aesthetic)

• add custom icons for the context menu of the system tray widget

0.6.1 (bug fix)

• fix udisks2 external device detection bug: all devices were considered external when using Sniffer (as done in the udiskie-mount and udiskie-umount tools)

0.6.0 (udisks2 support, bug fix)

• cache device states to avoid some race conditions

• show filesystem label in mount/unmount notifications

• retry to unlock LUKS devices when wrong password was entered twice

• show ‘eject’ only if media is available (udisks1 ejects only in this case)

• (un-) mount/lock notifications shown even when operations failed

• refactor internal API

• experimental support for udisks2

0.5.3 (feature, bug fix)

• add ‘__ignore__’ config file option to prevent handling specific devices

• delay notifications until termination of long operations

0.5.2 (tray icon)

• add tray icon (pygtk based)

• eject / detach drives from command line

0.5.1 (mainly internal changes)

• use setuptools entry points to create the executables

• make udiskie a namespace package

0.5.0 (LUKS support)

• support for LUKS devices (using zenity for password prompt)

• major refactoring

• use setuptools as installer