Demonstration release of the principles underpinning krsd.
[krsd] / demo / README.md
1 # Demonstration of krsd
2
3 This demonstration uses TODOMVC, a common example used to demonstratie
4 remoteStorage and Unhosted principles.  It is available under a MIT
5 license on https://github.com/tastejs/todomvc and included here in a
6 modified form.
7
8 The current demonstration is not suited for CORS yet, so you will have
9 to serve these files as part of your website's static content.  Do not
10 forget to setup the filesystem extended attribute user.mime_type on
11 each of the files so the krsd knows how to deliver them.
12
13 To use this, you can run krsd as follows:
14
15 krsd -p 443 --debug -n krsd.domain.tld --ssl --key-path=/etc/ssl/private/krsd.domain.tld-2014.pem --cert-path=/etc/ssl/certs/krsd.domain.tld-2014.pem --ca-path=/etc/ssl/certs/cacert.org.pem
16
17 You should create a /home/domain.tld/user/remotestorage path for your user data,
18 and setup a .k5remotestorage file with the Kerberos Principal Name that gets
19 R/W access to the data underneath it.
20
21 And of course, you'll need to setup Kerberos, and tell your browser to
22 use it on this site.  This may involve whitelisting the domain being
23 accessed, in a browser-specific manner.
24
25 This work has been shown to work with Safari, FireFox and Chrome, all run
26 under Mac OS X, using the builtin Kerberos support of Mac OS X.
27
28 The work done to modify remoteStorage in this demo will be ported back to
29 the remoteStorage main line and offered.  But it will first be integrated
30 into GitHub location https://github.com/arpa2/remotestorage.js in a branch
31 named "http-implied-auth".
32