path: root/jsaccess/README.txt
diff options
authorLaurent Ghigonis <laurent@p1sec.com>2013-06-18 04:40:11 +0200
committerLaurent Ghigonis <laurent@p1sec.com>2013-06-18 04:40:11 +0200
commit8be2746926595febca82774d408a912483392d83 (patch)
treea1b8d6259cbe23d549d310615a9e303c7305fd5c /jsaccess/README.txt
parentjsaccess: explicit rsync (diff)
jsaccess: doc updatejsaccess_store
Diffstat (limited to 'jsaccess/README.txt')
1 files changed, 11 insertions, 10 deletions
diff --git a/jsaccess/README.txt b/jsaccess/README.txt
index 97813bd..4127c1a 100644
--- a/jsaccess/README.txt
+++ b/jsaccess/README.txt
@@ -32,10 +32,9 @@ Deployment
There are 2 parts:
* The jsa/ directory that contains html / javascript files, for the user to
access files list and download. jsa/store/ is the files store.
-* The store.sh script for the web server owner to encrypt files
+* The store.sh script for the web server owner to manage file store.
It is recomanded to run store.sh on your laptop, and then syncronise the
-jsa/store/ file store with your server.
+jsa/store/ with your server.
Put jsa/ directory on your web server, publicly available.
@@ -45,18 +44,19 @@ Share a file
1. Add the file you want to share to the file store
On your laptop:
-$ ./store.sh myfile
+$ ./store.sh add myfile
# Then enter the passphase you want to use for encryption.
# It will tell you something like:
-CREATED jsa/store/af022cd820fdad6cbcac8e15ac565c639a47dab0/065e18a7f246b800242a778a6e8dd07a3321dac6
-UPDATED jsa/store/af022cd820fdad6cbcac8e15ac565c639a47dab0/index.txt
+CREATED file jsa/store/af022cd820fdad6cbcac8e15ac565c639a47dab0/065e18a7f246b800242a778a6e8dd07a3321dac6
+UPDATED file jsa/store/af022cd820fdad6cbcac8e15ac565c639a47dab0/index.txt
2. Syncronise the file store with you online server
On your laptop:
-$ rsync jsa/ user@myserver:/var/www/htdocs/
-# Upload both CREATED and UPDATED files to your server
-# You need to keep the correct full path
+# Set the rsync url (only once)
+./store.sh rset user@myserver:/var/www/htdocs/jsa/store/
+# push the file store
+./store.sh push
3. Direct people to the directory jsa/, e.g. http://myserver.com/jsa/
@@ -85,6 +85,7 @@ Dependencies / Compatibility
On the host that runs store.sh:
* openssl
* base64
+* optional: rsync, if you with to use ./store push to deploy your file store
On the web server:
* Serving static files is enough
@@ -100,7 +101,7 @@ Git content
jsa/ - should be on your webserver, can be renamed
jsa/store/<password_hash>/ - directory of files to download for a given password
jsa/store/<password_hash>/index.txt - list of file name available
-store.sh - to encrypt your files before uploading them to your web server
+store.sh - to encrypt the files that will be available for download