Commit 98e34a58 by Johannes Zellner

Update the readme

1 parent 86400066
Showing with 24 additions and 12 deletions
# Surfer # Surfer
Surfer is a Simple static file server. It comes with a commandline tool Surfer is a Simple static file server.
to upload files from your local folders. It comes with a commandline tool to upload files from your local folders and a webinterface to manage files directly on the server.
## Installation ## Installation
...@@ -15,6 +15,7 @@ cloudron install --appstore-id io.cloudron.surfer ...@@ -15,6 +15,7 @@ cloudron install --appstore-id io.cloudron.surfer
## Building ## Building
### Cloudron
The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html). The app package can be built using the [Cloudron command line tooling](https://cloudron.io/references/cli.html).
``` ```
...@@ -24,24 +25,35 @@ cloudron build ...@@ -24,24 +25,35 @@ cloudron build
cloudron install cloudron install
``` ```
### How to upload ### Standalone
Surfer can also be run standlone on any server:
You can upload files using the commandline tool. ```
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: Login using your Cloudron credentials:
```
surfer login <this app's url> surfer login <this app's url>
```
Put some files: Put some files:
```
surfer put [file]
```
surfer put [file]
## Testing ## 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. 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.
......
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!