Improved readme
This commit is contained in:
20
README.md
20
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://github.com/psi-4ward/psitransfer/releases)
|
||||
[](https://david-dm.org/psi-4ward/psitransfer)
|
||||
[](https://github.com/psi-4ward)
|
||||
[](https://github.com/psi-4ward/psitransfer)
|
||||
[](https://hub.docker.com/r/psitrax/psitransfer/)
|
||||
[](https://microbadger.com/images/psitrax/psitransfer)
|
||||
[](https://hub.docker.com/r/psitrax/psitransfer/)
|
||||
@@ -23,14 +23,14 @@ Simple open source self-hosted file sharing solution.
|
||||
|
||||
## Quickstart
|
||||
|
||||
### Docker (recommended)
|
||||
### Docker
|
||||
```bash
|
||||
$ docker run -p 0.0.0.0:3000:3000 -v $PWD/data:/data psitrax/psitransfer
|
||||
# data volume needs UID 1000
|
||||
$ sudo chown -R 1000 $PWD/data
|
||||
```
|
||||
|
||||
### Manual
|
||||
### Manual, precompiled
|
||||
|
||||
```bash
|
||||
# Be sure to have NodeJS >= 7.4
|
||||
@@ -45,6 +45,20 @@ $ NODE_ENV=production npm install
|
||||
$ 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
|
||||
|
||||
There are some configs in `config.js` like port and data-dir.
|
||||
|
||||
Reference in New Issue
Block a user