george/fiche
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
solusipse
2013-09-09 01:15:55 +02:00
parent 31022de8ec
commit ac40afb00b
1 changed files with 18 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@@ -64,6 +64,16 @@ buffer_size = 8192;
queue_size = 100; queue_size = 100;
``` ```
Examples:
```
fiche -d domain.com
```
```
fiche -s 6 -p 6666
```
### Basic arguments ### ### Basic arguments ###
Most important is providing **basedir** and **domain**. Most important is providing **basedir** and **domain**.
@@ -72,7 +82,7 @@ Basedir should be **absolute** path to directory where you would like to store t
Domain should be provided in such format ```domain.com```. Domain should be provided in such format ```domain.com```.
Slug size: ```yourserver.com/SLUG_OF_CHOSEN_LENGTH/```. Slug size: ```domain.com/SLUG_OF_CHOSEN_LENGTH/```.
### Parameters for advanced users ### ### Parameters for advanced users ###
@@ -80,7 +90,7 @@ Slug size: ```yourserver.com/SLUG_OF_CHOSEN_LENGTH/```.
- Queue size - Queue size
## Running as service ## ## Running as service ##
e
You can run fiche as service, there is simple systemd example: You can run fiche as service, there is simple systemd example:
``` ```
@@ -94,6 +104,12 @@ ExecStart=/usr/local/bin/fiche -d code.solusipse.net -o /home/www/code/
WantedBy=multi-user.target WantedBy=multi-user.target
``` ```
In service mode you have to set output directory with ```-d``` parameter, there's example:
```
fiche -o /home/www/code/
```
## Webserver ## ## Webserver ##
To make files available for users, you need to host them somehow. Http server is easiest option. Just set root To make files available for users, you need to host them somehow. Http server is easiest option. Just set root