Browse Source

updated README.md with committing infos

Nicolas Petton 13 years ago
parent
commit
cafa1d9698
1 changed files with 49 additions and 0 deletions
  1. 49 0
      README.md

+ 49 - 0
README.md

@@ -17,6 +17,55 @@ Some highlights:
 -    Jtalk includes a canvas to generate HTML, like [Seaside](http://www.seaside.st)
 -    Jtalk includes a [jQuery](http://www.jquery.com) binding
 
+How to commit changes from the web-based IDE
+--------------------------------------------
+
+The Jtalk class browser is abled to commit changes to disk.
+The "commit category" button will send a PUT request with the JS code of all classes in the selected class category in a file named js/CATEGORY.js
+
+The easiest way to enable committing is probably to setup a webdav with Apache.
+
+The following steps explain how to setup a webdav for Jtalk with Debian, but the setup on OSX and other Linux distros should be similar.
+
+### Install Apache and enable the dav module
+
+    apt-get install apache
+    a2enmod dav
+
+### Create a password for the webdav
+
+    htpasswd -c /etc/apache2/htpasswd-webdav USERNAME
+
+### Setup the webdav for Jtalk
+
+Add the following lines to the default vhost (in /etc/apache2/sites-available/default):
+
+    Alias /jtalk/ "/path/to/jtalk/"
+        <Directory "/path/to/jtalk/">
+            Options Indexes MultiViews FollowSymLinks
+	    DirectoryIndex index.html
+	    AllowOverride None
+    	    Order allow,deny
+	    allow from all
+
+	    Dav on
+
+	    AuthType Basic
+            AuthName "jtalk"
+            AuthUserFile /etc/apache2/htpassword-webdav
+	    <LimitExcept GET OPTIONS>
+                Require valid-user
+	    </LimitExcept>
+
+        </Directory>
+
+
+Make sure the group www-data has required rights to modify files in the webdav directory.
+
+### Restart Apache
+    
+    /etc/init.d/apache restart
+
 License
 -------