From: Johannes Zellner Date: Mon, 4 Jul 2016 12:43:12 +0000 (+0200) Subject: Update the readme X-Git-Url: https://git.immae.eu/?p=perso%2FImmae%2FProjets%2FNodejs%2FSurfer.git;a=commitdiff_plain;h=98e34a58a23079ccfa6300ba72f0d3d0bcf3b676 Update the readme --- diff --git a/README.md b/README.md index 74488c3..79697a2 100644 --- 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,6 +15,7 @@ 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). ``` @@ -24,24 +25,35 @@ 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://github.com/nebulade/surfer.git +cd surfer +npm install +./app.js +``` +Without LDAP integration, the default username is `test` with the same password. Check `src/auth.js` for further details about user management. -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 - +``` +surfer login +``` Put some files: +``` +surfer put [file] +``` - surfer put [file] - ## Testing 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.