ttt/transfer
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improved readme

Browse Source
This commit is contained in:
Christoph Wiechert
2017-04-25 18:20:09 +02:00
parent 38b1de48cf
commit 85a88a80c6
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -2,7 +2,7 @@
[![Current Release](https://img.shields.io/github/release/psi-4ward/psitransfer.svg)](https://github.com/psi-4ward/psitransfer/releases) [![Current Release](https://img.shields.io/github/release/psi-4ward/psitransfer.svg)](https://github.com/psi-4ward/psitransfer/releases)
[![Dependencies](https://david-dm.org/psi-4ward/psitransfer.svg)](https://david-dm.org/psi-4ward/psitransfer) [![Dependencies](https://david-dm.org/psi-4ward/psitransfer.svg)](https://david-dm.org/psi-4ward/psitransfer)
[![Github Stars](https://img.shields.io/github/stars/psi-4ward/psitransfer.svg?style=social&label=Star)](https://github.com/psi-4ward) [![Github Stars](https://img.shields.io/github/stars/psi-4ward/psitransfer.svg?style=social&label=Star)](https://github.com/psi-4ward/psitransfer)
[![Docker Stars](https://img.shields.io/docker/stars/psitrax/psitransfer.svg)](https://hub.docker.com/r/psitrax/psitransfer/) [![Docker Stars](https://img.shields.io/docker/stars/psitrax/psitransfer.svg)](https://hub.docker.com/r/psitrax/psitransfer/)
[![Image Size](https://images.microbadger.com/badges/image/psitrax/psitransfer.svg)](https://microbadger.com/images/psitrax/psitransfer) [![Image Size](https://images.microbadger.com/badges/image/psitrax/psitransfer.svg)](https://microbadger.com/images/psitrax/psitransfer)
[![Docker Pulls](https://img.shields.io/docker/pulls/psitrax/psitransfer.svg)](https://hub.docker.com/r/psitrax/psitransfer/) [![Docker Pulls](https://img.shields.io/docker/pulls/psitrax/psitransfer.svg)](https://hub.docker.com/r/psitrax/psitransfer/)
@@ -23,14 +23,14 @@ Simple open source self-hosted file sharing solution.
## Quickstart ## Quickstart
### Docker (recommended) ### Docker
```bash ```bash
$ docker run -p 0.0.0.0:3000:3000 -v $PWD/data:/data psitrax/psitransfer $ docker run -p 0.0.0.0:3000:3000 -v $PWD/data:/data psitrax/psitransfer
# data volume needs UID 1000 # data volume needs UID 1000
$ sudo chown -R 1000 $PWD/data $ sudo chown -R 1000 $PWD/data
``` ```
### Manual ### Manual, precompiled
```bash ```bash
# Be sure to have NodeJS >= 7.4 # Be sure to have NodeJS >= 7.4
@@ -45,6 +45,20 @@ $ NODE_ENV=production npm install
$ npm start $ npm start
``` ```
### Manual, from source
```bash
# Compile the frontend apps
$ cd app
$ npm install
$ npm run build
# Install dependencies
$ cd ..
$ npm install
$ npm start
```
### Configuration ### Configuration
There are some configs in `config.js` like port and data-dir. There are some configs in `config.js` like port and data-dir.