Byron Clark avatar Byron Clark committed 40f3c1a

Add a readme.

closes issue 4

Comments (0)

Files changed (1)

+=======
+udiskie
+=======
+
+udiskie is a simple daemon that uses udisks_ to automatically mount removable
+storage devices.
+
+.. _udisks: http://www.freedesktop.org/wiki/Software/udisks
+
+Permissions
+-----------
+
+udiskie requires permission for the ``org.freedesktop.udisks.filesystem-mount``
+action.  This is usually granted in sessions launched with ConsoleKit_ support.
+If run outside a desktop manager with ConsoleKit_ support, the permission can be
+granted using PolicyKit_ by creating a file called ``10-udiskie.pkla`` in
+``/etc/polkit-1/localauthority/50-local.d`` with these contents:
+
+.. _ConsoleKit: http://www.freedesktop.org/wiki/Software/ConsoleKit
+.. _PolicyKit: http://www.freedesktop.org/wiki/Software/PolicyKit
+
+::
+
+    [udiskie]
+    Identity=unix-group:storage
+    Action=org.freedesktop.udisks.filesystem-mount
+    ResultAny=yes
+
+This configuration allows all members of the storage group to run udiskie.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.