Unified · Split
| @@ -29,9 +29,10 @@ GLOBAL SETTINGS · 28 unmodified lines | ||
| 29 | 29 | about-filter:: |
| 30 | 30 | Specifies a command which will be invoked to format the content of |
| 31 | 31 | about pages (both top-level and for each repository). The command will |
| 32 | − get the content of the about-file on its STDIN, and the STDOUT from the | |
| 33 | − command will be included verbatim on the about page. Default value: | |
| 34 | − none. See also: "FILTER API". | |
| 32 | + get the content of the about-file on its STDIN, the name of the file | |
| 33 | + as the first argument, and the STDOUT from the command will be | |
| 34 | + included verbatim on the about page. Default value: none. See | |
| 35 | + also: "FILTER API". | |
| 35 | 36 | |
| 36 | 37 | agefile:: |
| 37 | 38 | Specifies a path, relative to each repository path, which can be used |
| @@ -288,8 +289,9 @@ project-list:: · 250 unmodified lines | ||
| 288 | 289 | EXPANSION". |
| 289 | 290 | |
| 290 | 291 | readme:: |
| 291 | − Text which will be used as default value for "repo.readme". Default | |
| 292 | − value: none. | |
| 292 | + Text which will be used as default value for "repo.readme". Multiple | |
| 293 | + files may be specified, separated by a space, and cgit will use the | |
| 294 | + first found file in this list. Default value: none. | |
| 293 | 295 | |
| 294 | 296 | remove-suffix:: |
| 295 | 297 | If set to "1" and scan-path is enabled, if any repositories are found |
| @@ -507,7 +509,10 @@ repo.readme:: · 211 unmodified lines | ||
| 507 | 509 | git refspec by head or by hash by prepending the refspec followed by |
| 508 | 510 | a colon. For example, "master:docs/readme.mkd". If the value begins |
| 509 | 511 | with a colon, i.e. ":docs/readme.rst", the default branch of the |
| 510 | − repository will be used. Default value: <readme>. | |
| 512 | + repository will be used. Sharing any file will expose that entire | |
| 513 | + directory tree to the "/about/PATH" endpoints, so be sure that there | |
| 514 | + are no non-public files located in the same directory as the readme | |
| 515 | + file. Default value: <readme>. | |
| 511 | 516 | |
| 512 | 517 | repo.snapshots:: |
| 513 | 518 | A mask of allowed snapshot-formats for this repo, restricted by the |