Thu Aug 29 12:30:41+0300 2024
271be88
Document optional parameters
README.md
| 49 | 49 | (config | |
| 50 | 50 | (port 8080) | |
| 51 | 51 | (host "localhost") | |
| 52 | - | (database "") | |
| 52 | + | (database ((asset-directory . #f) | |
| 53 | + | (avatar-url-template . "https://avatar.lepiller.eu/cat-avatar-generator.php?seed=$hash") | |
| 54 | + | (avatar-hash-algorithm . sha1))) | |
| 53 | 55 | (repositories "/srv/git") | |
| 54 | 56 | (base-git-url "https://git.example.org/git") | |
| 55 | 57 | (index-title "My projects") | |
… | |||
| 59 | 61 | ||
| 60 | 62 | * port: the port on which to listen | |
| 61 | 63 | * host: the host on which to listen | |
| 62 | - | * database: currently unused | |
| 64 | + | * database: currently abused to set additional optional parameters | |
| 63 | 65 | * repositories: The directory in which public repositories can be found | |
| 64 | 66 | * base-git-url: The base url for cloning repositories | |
| 65 | 67 | * index-title: The title for the index page | |
… | |||
| 68 | 70 | * footer: The content of the footer text on all pages. It is also a list of | |
| 69 | 71 | sxml expressions. | |
| 70 | 72 | ||
| 73 | + | Database can be set to an alist of the following keys and values: | |
| 74 | + | ||
| 75 | + | * asset-directory: the string with a full path to the static asset | |
| 76 | + | directory of gitile to serve them for development or the #f value to | |
| 77 | + | disable this feature. | |
| 78 | + | * avatar-url-template: the string containing an avatar generator url | |
| 79 | + | template where the string $hash is replaced with commit email hash. | |
| 80 | + | * avatar-hash-algorithm: the symbol of a gcrypt hash algorithm used | |
| 81 | + | for computing commit email hash. | |
| 82 | + | ||
| 83 | + | The config example above represents the default values for these keys. | |
| 84 | + | ||
| 71 | 85 | Save the file as `gitile.conf` (or whatever name you like) and run gitile with | |
| 72 | 86 | ||
| 73 | 87 | ```bash | |