noury/mirror-yaf
1
0
Fork 0
mirror of https://github.com/lyx0/yaf.git synced 2024-11-13 19:49:53 +01:00
Code Issues Projects Releases Packages Wiki Activity

doc: subdivide "Configuration" section

Browse source
This commit is contained in:
Leon Richardt 2020-10-29 10:14:11 +01:00
parent 9cd60561e2
commit bb8cb748d9
No known key found for this signature in database
GPG key ID: AD8BDD6273FE8FC5
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -19,6 +19,7 @@ go test
If you plan on using a systemd service or another init system, you might want to move the `jaf` executable to a different directory (e.g. `/opt`) at this point; you know your setup best. If you plan on using a systemd service or another init system, you might want to move the `jaf` executable to a different directory (e.g. `/opt`) at this point; you know your setup best.
## Configuration ## Configuration
### jaf
There are just a few parameters that need to be configured for jaf. There are just a few parameters that need to be configured for jaf.
Refer to the `example.conf` file: Refer to the `example.conf` file:
``` ```
@ -40,6 +41,7 @@ Make sure the user running jaf has suitable permissions to read, and write to, `
Also note that `LinkLength` directly relates to the number of files that can be saved. Also note that `LinkLength` directly relates to the number of files that can be saved.
Since jaf only uses alphanumeric characters for file name generation, a maximum of `(26 + 26 + 10)^LinkLength` names can be generated. Since jaf only uses alphanumeric characters for file name generation, a maximum of `(26 + 26 + 10)^LinkLength` names can be generated.
### nginx
If you use a reverse-proxy to forward requests to jaf, make sure to correctly forward the original request headers. If you use a reverse-proxy to forward requests to jaf, make sure to correctly forward the original request headers.
For nginx, this is achieved via the `proxy_pass_request_headers on;` option. For nginx, this is achieved via the `proxy_pass_request_headers on;` option.