projekte:dokufs
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
projekte:dokufs [2008/05/10 23:03] – angelegt michitux | projekte:dokufs [2012/01/28 15:57] (current) – Some typos fixed michitux | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== DokuFS ====== | ====== DokuFS ====== | ||
- | |||
- | //Dieser Artikel ist in Englisch geschrieben, | ||
DokuFS is a filesystem that allows, with the help of [[wp> | DokuFS is a filesystem that allows, with the help of [[wp> | ||
- | 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 [[http://www.chimeric.de/ | + | All pages have the extension .dw so you can easily handle syntax highlighting (syntax highlighting for vim is included in the unfortunately discontinued |
- | Every 5 minutes, the recent changes of the Wiki are pulled and the directory-structure is updated. | + | 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/ | ||
===== Some notes on the current version ===== | ===== Some notes on the current version ===== | ||
Line 15: | Line 15: | ||
The current version has to be considered as alpha version as nobody besides me has ever used DokuFS. Known issues are: | The current version has to be considered as alpha version as nobody besides me has ever used DokuFS. Known issues are: | ||
- | * There is no cache for pages, every read of a page causes a request to the server. As some filebrowsers read the content of every file, directory listing might be very slow. | ||
* There is no recognition if a file was saved correctly or not. When you are admin this might not be an issue, but when you are not sure if you have permission to write/ | * There is no recognition if a file was saved correctly or not. When you are admin this might not be an issue, but when you are not sure if you have permission to write/ | ||
* When the file/ | * When the file/ | ||
Line 21: | Line 20: | ||
===== License ===== | ===== License ===== | ||
- | Copyright (C) 2008 | + | Copyright (C) 2009 |
This program is free software: you can redistribute it and/or modify | This program is free software: you can redistribute it and/or modify | ||
Line 40: | Line 39: | ||
===== Installation ===== | ===== Installation ===== | ||
- | First of all you need a working [[http:// | + | DokuFS runs on Linux, it might work on Mac OS X and from all I know it doesn' |
- | The most tricky part is the installation | + | First of all you need a working |
- | Then you can download {{:projekte:dokufs:dokufs.rb|dokufs.rb}} and make it executable with <code bash> | + | You need [[http:// |
+ | |||
+ | You can download the latest version of DokuFS from its [[https:// | ||
===== Usage ===== | ===== Usage ===== | ||
- | In short: | + | < |
- | + | Usage: dokufs.rb [options] directory | |
- | Usage: dokufs.rb [-user | + | -u, --user USER The username |
- | + | -p, --password | |
- | The longer version: | + | -s, --server |
+ | --path PATH The path to XMLRPC (default: | ||
+ | | ||
+ | -m, --media | ||
+ | | ||
+ | -n, --no-cache | ||
+ | -h, --help | ||
+ | </ | ||
- | * -user user -password password - the authentication passed to DokuWiki. Default | + | Some notes on that: Server |
- | * -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 / | + | |
- | * -no-ssl - don't use SSL. By default DokuFS is using SSL to connect to the server, this is highly recommended | + | |
Creating new directories allows you to create new pages in new namespaces, but this creation itself has no effect on the Wiki. | Creating new directories allows you to create new pages in new namespaces, but this creation itself has no effect on the Wiki. | ||
Line 63: | Line 68: | ||
When the first line of a file begins with %, everything after this % (and an optional whitespace) up to the end of the line is considered as commit message. When saving an empty file or a file that contains only a line beginning with %, the page is deleted. So you can delete a page playground: | When the first line of a file begins with %, everything after this % (and an optional whitespace) up to the end of the line is considered as commit message. When saving an empty file or a file that contains only a line beginning with %, the page is deleted. So you can delete a page playground: | ||
- | Unmounting the filesystem is bit tricky. You have to call <code bash> | + | Unmounting the filesystem is bit tricky. You have to call <code bash> |
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. | 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> | + | |
- | ~~LINKBACK~~ | + | |
- | ~~DISCUSSION~~ | + | |
projekte/dokufs.1210453421.txt.gz · Last modified: 2008/05/10 23:03 by michitux