]>
Commit | Line | Data |
---|---|---|
d56e255f GR |
1 | # Surfer |
2 | ||
98e34a58 JZ |
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. | |
d56e255f GR |
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 | ||
98e34a58 | 18 | ### Cloudron |
d56e255f GR |
19 | The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html). |
20 | ||
21 | ``` | |
22 | cd surfer | |
23 | ||
24 | cloudron build | |
25 | cloudron install | |
26 | ``` | |
27 | ||
98e34a58 JZ |
28 | ### Standalone |
29 | Surfer can also be run standlone on any server: | |
30 | ``` | |
31 | git clone https://github.com/nebulade/surfer.git | |
32 | cd surfer | |
33 | npm install | |
553c79b0 | 34 | ./app.js <public folder> |
98e34a58 JZ |
35 | ``` |
36 | Without LDAP integration, the default username is `test` with the same password. Check `src/auth.js` for further details about user management. | |
d56e255f | 37 | |
98e34a58 | 38 | ## File management |
d56e255f | 39 | |
98e34a58 | 40 | The admin interface is available under the `/_admin` location or you can upload files using the commandline tool. |
d56e255f | 41 | |
98e34a58 JZ |
42 | First, install the surfer cli tool using npm. |
43 | ``` | |
44 | npm -g install cloudron-surfer | |
45 | ``` | |
d56e255f GR |
46 | |
47 | Login using your Cloudron credentials: | |
98e34a58 JZ |
48 | ``` |
49 | surfer login <this app's url> | |
50 | ``` | |
d56e255f GR |
51 | |
52 | Put some files: | |
98e34a58 JZ |
53 | ``` |
54 | surfer put [file] | |
55 | ``` | |
d56e255f | 56 | |
ebd7ed7a GR |
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 | ``` | |
755569a3 | 62 | cd surfer |
ebd7ed7a GR |
63 | |
64 | npm install | |
755569a3 | 65 | USERNAME=<cloudron username> PASSWORD=<cloudron password> mocha --bail test/test.js |
ebd7ed7a GR |
66 | ``` |
67 |