path: root/jsaccess/README.txt
diff options
authorLaurent Ghigonis <laurent@p1sec.com>2013-06-18 12:59:04 +0200
committerLaurent Ghigonis <laurent@p1sec.com>2013-06-18 12:59:04 +0200
commit9d8d6e2cacc4b66499dd233432869ef17151a733 (patch)
tree73dcaa629323398bf5d7e457de215ff717c09e96 /jsaccess/README.txt
parentjsaccess: main Makefile (diff)
jsaccess: naming
Diffstat (limited to 'jsaccess/README.txt')
1 files changed, 8 insertions, 8 deletions
diff --git a/jsaccess/README.txt b/jsaccess/README.txt
index 4127c1a..7d7292b 100644
--- a/jsaccess/README.txt
+++ b/jsaccess/README.txt
@@ -32,8 +32,8 @@ 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 manage file store.
-It is recomanded to run store.sh on your laptop, and then syncronise the
+* The jstore script for the web server owner to manage file store.
+It is recomanded to run jstore on your laptop, and then syncronise the
jsa/store/ with your server.
Put jsa/ directory on your web server, publicly available.
@@ -44,7 +44,7 @@ Share a file
1. Add the file you want to share to the file store
On your laptop:
-$ ./store.sh add myfile
+$ jstore add myfile
# Then enter the passphase you want to use for encryption.
# It will tell you something like:
@@ -54,9 +54,9 @@ UPDATED file jsa/store/af022cd820fdad6cbcac8e15ac565c639a47dab0/index.txt
2. Syncronise the file store with you online server
On your laptop:
# Set the rsync url (only once)
-./store.sh rset user@myserver:/var/www/htdocs/jsa/store/
+jstore rset user@myserver:/var/www/htdocs/jsa/store/
# push the file store
-./store.sh push
+jstore push
3. Direct people to the directory jsa/, e.g. http://myserver.com/jsa/
@@ -64,7 +64,7 @@ On your laptop:
How it works
-store.sh creates a directory jsa/store/<rmd160_hash_of_passphrase>/.
+jstore creates a directory jsa/store/<rmd160_hash_of_passphrase>/.
It encrypts your file using AES256 with the passphrase and stores the result in
It also updates the index of available files per directory called index.txt,
@@ -82,7 +82,7 @@ Filesaver JS API.
Dependencies / Compatibility
-On the host that runs store.sh:
+On the host that runs jstore:
* openssl
* base64
* optional: rsync, if you with to use ./store push to deploy your file store
@@ -101,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 the files that will be available for download
+jstore - to encrypt the files that will be available for download