Differences

This shows you the differences between two versions of the page.

--- projekte:dokufs [2008/06/21 21:46] – cache implemented michitux
+++ projekte:dokufs [2012/01/28 15:57] (current) – Some typos fixed michitux
@@ Line 1: / Line 1: @@
 ====== DokuFS ======
-//Dieser Artikel ist in Englisch geschrieben, da dieses Projekt ein internationales Publikum und ausschließlich Benutzer mit fortgeschrittenen Linuxkenntnissen anspricht.//
 DokuFS is a filesystem that allows, with the help of [[wp>Filesystem_in_Userspace|Fuse]], to mount a [[doku>wiki:DokuWiki|DokuWiki]] over [[wp>XML-RPC]] into you local filesystem on Linux.
-You are then able to browse the filesystem and to create, edit or delete files, that means to create, edit or delete pages on the Wiki you have mounted. Deleting, moving and copying of whole namespaces should work, too.
+You are then able to browse the filesystem and to create, edit or delete files, that means to create, edit or delete pages or media files on the Wiki you have mounted. Deleting, moving and copying of whole namespaces should work, too (however the history of pages is not moved).
+All pages have the extension .dw so you can easily handle syntax highlighting (syntax highlighting for vim is included in the unfortunately discontinued [[https://github.com/chimeric/dokuwikixmlrpc|DokuVimKi]] project, though you don't need the rest of DokuVimKi when using DokuFS).
-All pages have the extension .dw so you can easily handle syntax highlighting (syntax highlighting for vim is included in [[http://www.chimeric.de/projects/dokuwiki/dokuvimki|DokuVimKi]], though you don't need the rest of DokuVimKi when using DokuFS). The creation of other files but those with the extension .dw isn't allowed (temporary files of some editors are handled by DokuFS). In a later version when the XML-RPC-API of DokuWiki supports media management, the up- and download of media-files might be supported, too.
+DokuFS supports two modes -- one for pages and one for media files. In the mode for pages the creation of other files but those with the extension .dw isn't allowed (temporary files of VIM and Emacs are handled in memory). In the mode for media files every file is simply uploaded to the DokuWiki, so basically all file types are allowed that are supported by your DokuWiki installation.
-Every 5 minutes, the recent changes of the Wiki are pulled and the directory-structure is updated. Once a page is downloaded it will be in a cache (with a memory limit) so that only the first read/size-request will be slow.
+Every 5 minutes, the recent changes of the Wiki are pulled and the directory structure is updated. Once a page is downloaded it will be in a cache (with a memory limit) so that only the first read/size-request will be slow.
 ===== Some notes on the current version =====
@@ Line 20: / Line 20: @@
 ===== License =====
-Copyright (C) 2008  Michael Hamann
+Copyright (C) 2009  Michael Hamann
 This program is free software: you can redistribute it and/or modify
@@ Line 39: / Line 39: @@
 ===== Installation =====
-First of all you need a working [[http://www.ruby-lang.org|Ruby]]-installation and of course DokuWiki with enabled XML-RPC-backend.
+DokuFS runs on Linux, it might work on Mac OS X and from all I know it doesn't work on Windows.
-The most tricky part is the installation of [[http://rubyforge.org/projects/fusefs/|FuseFS]]. The only Linux distributions I know that have packages or to be more correct: build-files for FuseFS, are [[http://packages.gentoo.org/package/dev-ruby/fusefs|Gentoo]] and [[http://aur.archlinux.org/packages.php?ID=4051|Arch Linux (AUR)]]. In all other cases there are instructions in README.txt which is distributed with FuseFS.
+First of all you need a working [[http://www.ruby-lang.org|Ruby]]-installation and of course DokuWiki with enabled XML-RPC-backend (note that you need to enable it and set a user that can access the wiki over XML-RPC, allowing access for all users is **not** recommended).
-Then you can download {{:projekte:dokufs:dokufs.rb|dokufs.rb}} and make it executable with <code bash>chmod +x dokufs.rb</code>. You might want to put DokuFS in one of your directories in $PATH, this might be ~/bin/.
+You need [[http://rubyforge.org/projects/fusefs/|FuseFS]] in order to use DokuFS. In Debian and Ubuntu (and derivates of them) it is provided in a package named ''libfusefs-ruby''. In Gentoo there is a package named [[http://packages.gentoo.org/package/dev-ruby/fusefs|fusefs]] and in ArchLinux it is in the [[http://aur.archlinux.org/packages.php?ID=4051|AUR]]. In all other cases there are instructions in README.txt which is distributed with FuseFS.
+You can download the latest version of DokuFS from its [[https://github.com/michitux/dokufs|git repository]]. You just need the file ''dokufs.rb'' and then you should make it executable with <code bash>chmod +x dokufs.rb</code>. You might want to put DokuFS in one of your directories in $PATH, this might be ~/bin/.
 ===== Usage =====
-In short:
+<code>
+Usage: dokufs.rb [options] directory
+    -u, --user USER                  The username
+    -p, --password PASSWORD          The password
+    -s, --server SERVER              The server to use (default: localhost)
+        --path PATH                  The path to XMLRPC (default: /lib/exe/xmlrpc.php)
+        --[no-]ssl                   Use (no) ssl (default: use ssl)
+    -m, --media                      Display media files instead of wiki pages
+        --update-interval INTERVAL   The update interval in seconds
+    -n, --no-cache                   Don't use the cache - this will cause a significantly higher load on the server. (default: use cache)
+    -h, --help                       Show this message
+</code>
-Usage: dokufs.rb [-user your_username -password your_password] [-server your_server.com] [-path /your/path/to/lib/exe/xmlrpc.php] [-no-ssl] path/where/to/mount/
+Some notes on that: Server is the domain name of the server the DokuWiki you want to mount is on. Don't include a protocol (e.g. http) here. You only need to specify the path when you DokuWiki-installation is not in the root directory of your domain. Using SSL is highly recommended, only use disable ssl when you don't have any other option.
-The longer version:
-  * -user user -password password - the authentication passed to DokuWiki. Default is no authentication at all.
-  * -server www.example.com - the domain name of the server the DokuWiki you want to mount is on. Don't include a protocol (e.g. http) here. Default is localhost.
-  * -path /your/path/to/lib/exe/xmlrpc.php - default is /lib/exe/xmlrpc.php, so you only need this option when you want to use a DokuWiki-installation which is not in the root-directory of the domain.
-  * -no-ssl - don't use SSL. By default DokuFS is using SSL to connect to the server, this is highly recommended so use this option only if there is no other possibility.
 Creating new directories allows you to create new pages in new namespaces, but this creation itself has no effect on the Wiki.
@@ Line 66: / Line 72: @@
 If there are any further questions or requests, you may contact me using comments here or you can send me an email at michael <at> content-space.de. Jabber is available, too, the address is the same as my email-address.
-{{tag>dokuwiki fuse filesystem ruby}}
-~~LINKBACK~~
-~~DISCUSSION~~