applications/linx-server
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
andreimarcu 2016-06-14 23:38:36 -07:00
parent 47a1aa6396
commit e8d2d75c1c
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -23,7 +23,7 @@ Self-hosted file/media sharing website.
Get release and run Get release and run
------------------- -------------------
1. Grab the latest binary from the [releases](https://github.com/andreimarcu/linx-server/releases) 1. Grab the latest binary from the [releases](https://github.com/andreimarcu/linx-server/releases)
2. Run ```./linx-server...``` 2. Run ```./linx-server```
Usage Usage
@ -32,17 +32,16 @@ Usage
#### Configuration #### Configuration
All configuration options are accepted either as arguments or can be placed in an ini-style file as such: All configuration options are accepted either as arguments or can be placed in an ini-style file as such:
```ini ```ini
sitename = "my linx" maxsize = 4294967296
siteurl = "https://linx.example.com" allowhotlink = true
remoteuploads = true
# etc # etc
``` ```
...and then invoke ```linx-server -config path/to/config.ini``` ...and then invoke ```linx-server -config path/to/config.ini```
#### Common options #### Options
- ```-bind 127.0.0.1:8080``` -- what to bind to (default is 127.0.0.1:8080) - ```-bind 127.0.0.1:8080``` -- what to bind to (default is 127.0.0.1:8080)
- ```-sitename myLinx``` -- the site name displayed on top (default is linx) - ```-sitename myLinx``` -- the site name displayed on top (default is inferred from Host header)
- ```-siteurl "http://mylinx.example.org/"``` -- the site url (for generating links) - ```-siteurl "http://mylinx.example.org/"``` -- the site url (default is inferred from execution context)
- ```-filespath files/"``` -- Path to store uploads (default is files/) - ```-filespath files/"``` -- Path to store uploads (default is files/)
- ```-metapath meta/``` -- Path to store information about uploads (default is meta/) - ```-metapath meta/``` -- Path to store information about uploads (default is meta/)
- ```-maxsize 4294967296``` -- maximum upload file size in bytes (default 4GB) - ```-maxsize 4294967296``` -- maximum upload file size in bytes (default 4GB)