diff options
author | Johannes Zellner <johannes@nebulon.de> | 2016-07-04 14:43:12 +0200 |
---|---|---|
committer | Johannes Zellner <johannes@nebulon.de> | 2016-07-04 14:43:12 +0200 |
commit | 98e34a58a23079ccfa6300ba72f0d3d0bcf3b676 (patch) | |
tree | 3e2c7c9be14605f6e722d97e74629f62e387e639 | |
parent | 864000660c3184c5c31667d0a95b146e9e9af757 (diff) | |
download | Surfer-98e34a58a23079ccfa6300ba72f0d3d0bcf3b676.tar.gz Surfer-98e34a58a23079ccfa6300ba72f0d3d0bcf3b676.tar.zst Surfer-98e34a58a23079ccfa6300ba72f0d3d0bcf3b676.zip |
Update the readme
-rw-r--r-- | README.md | 36 |
1 files changed, 24 insertions, 12 deletions
@@ -1,7 +1,7 @@ | |||
1 | # Surfer | 1 | # Surfer |
2 | 2 | ||
3 | Surfer is a Simple static file server. It comes with a commandline tool | 3 | Surfer is a Simple static file server. |
4 | to upload files from your local folders. | 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 | 5 | ||
6 | ## Installation | 6 | ## Installation |
7 | 7 | ||
@@ -15,6 +15,7 @@ cloudron install --appstore-id io.cloudron.surfer | |||
15 | 15 | ||
16 | ## Building | 16 | ## Building |
17 | 17 | ||
18 | ### Cloudron | ||
18 | The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html). | 19 | The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html). |
19 | 20 | ||
20 | ``` | 21 | ``` |
@@ -24,24 +25,35 @@ cloudron build | |||
24 | cloudron install | 25 | cloudron install |
25 | ``` | 26 | ``` |
26 | 27 | ||
27 | ### How to upload | 28 | ### Standalone |
28 | 29 | Surfer can also be run standlone on any server: | |
29 | You can upload files using the commandline tool. | 30 | ``` |
31 | git clone https://github.com/nebulade/surfer.git | ||
32 | cd surfer | ||
33 | npm install | ||
34 | ./app.js | ||
35 | ``` | ||
36 | Without LDAP integration, the default username is `test` with the same password. Check `src/auth.js` for further details about user management. | ||
30 | 37 | ||
31 | First, install the surfer cli tool using npm. | 38 | ## File management |
32 | 39 | ||
33 | sudo npm -g install cloudron-surfer | 40 | The admin interface is available under the `/_admin` location or you can upload files using the commandline tool. |
34 | 41 | ||
42 | First, install the surfer cli tool using npm. | ||
43 | ``` | ||
44 | npm -g install cloudron-surfer | ||
45 | ``` | ||
35 | 46 | ||
36 | Login using your Cloudron credentials: | 47 | Login using your Cloudron credentials: |
37 | 48 | ``` | |
38 | surfer login <this app's url> | 49 | surfer login <this app's url> |
39 | 50 | ``` | |
40 | 51 | ||
41 | Put some files: | 52 | Put some files: |
53 | ``` | ||
54 | surfer put [file] | ||
55 | ``` | ||
42 | 56 | ||
43 | surfer put [file] | ||
44 | |||
45 | ## Testing | 57 | ## Testing |
46 | 58 | ||
47 | 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. | 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. |