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