README.md

   1 # Surfer
   2
   3 Surfer is a Simple static file server.
   4 It comes with a commandline tool to upload files from your local folders and a webinterface to manage files directly on the server.
   5
   6 ## Installation
   7
   8 [![Install](https://cloudron.io/img/button32.png)](https://cloudron.io/button.html?app=io.cloudron.surfer)
   9
  10 or using the [Cloudron command line tooling](https://cloudron.io/references/cli.html)
  11
  12 ```
  13 cloudron install --appstore-id io.cloudron.surfer
  14 ```
  15
  16 ## Building
  17
  18 ### Cloudron
  19 The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
  20
  21 ```
  22 git clone https://git.cloudron.io/cloudron/surfer.git
  23 cd surfer
  24 cloudron build
  25 cloudron install
  26 ```
  27
  28 ### Standalone
  29 Surfer can also be run standlone on any server:
  30 ```
  31 git clone https://git.cloudron.io/cloudron/surfer.git
  32 cd surfer
  33 npm install
  34 ./server.js <public folder>
  35 ```
  36 Use the `admin` tool to manage local users.
  37
  38 ## File management
  39
  40 The admin interface is available under the `/_admin` location or you can upload files using the commandline tool.
  41
  42 First, install the surfer cli tool using npm.
  43 ```
  44 npm -g install cloudron-surfer
  45 ```
  46
  47 Login using your Cloudron credentials:
  48 ```
  49 surfer login <this app's url>
  50 ```
  51
  52 Put some files:
  53 ```
  54 surfer put [file]
  55 ```
  56
  57 ## Testing
  58
  59 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.
  60
  61 ```
  62 cd surfer
  63
  64 npm install
  65 USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test/test.js
  66 ```