Make listen port and ldap filter more flexible

[perso/Immae/Projets/Nodejs/Surfer.git] / README.md

diff --git a/README.md b/README.md
index b9402584f41d8255d5e12d700a0d3fc4fe1159cf..e4061dfe87b3017cf22b3ba0029f888d550b1491 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Surfer
 
-Surfer is a Simple static file server. It comes with a commandline tool
-to upload files from your local folders.
+Surfer is a Simple static file server.
+It comes with a commandline tool to upload files from your local folders and a webinterface to manage files directly on the server.
 
 ## Installation
 
@@ -15,30 +15,52 @@ cloudron install --appstore-id io.cloudron.surfer
 
 ## Building
 
+### Cloudron
 The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
 
 ```
+git clone https://git.cloudron.io/cloudron/surfer.git
 cd surfer
-
 cloudron build
 cloudron install
 ```
 
-### How to upload
-
-You can upload files using the commandline tool.
+### Standalone
+Surfer can also be run standlone on any server:
+```
+git clone https://git.cloudron.io/cloudron/surfer.git
+cd surfer
+npm install
+./server.js <public folder>
+```
+Use the `admin` tool to manage local users.
 
-First, install the surfer cli tool using npm.
+## File management
 
-    sudo npm -g install cloudron-surfer
+The admin interface is available under the `/_admin` location or you can upload files using the commandline tool.
 
+First, install the surfer cli tool using npm.
+```
+npm -g install cloudron-surfer
+```
 
 Login using your Cloudron credentials:
+```
+surfer login <this app's url>
+```
 
-    surfer login <this app's url>
+Put some files:
+```
+surfer put [file]
+```
 
+## Testing
 
-Put some files:
+The e2e tests are located in the `test/` folder and require [nodejs](http://nodejs.org/). They are creating a fresh build, install the app on your Cloudron, perform tests, backup, restore and test if the files are still ok.
 
-    surfer put [file]
- 
+```
+cd surfer
+
+npm install
+USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test/test.js
+```