1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100
101. 101
102. 102
103. 103
104. 104
105. 105
106. 106
107. 107
108. 108
109. 109
110. 110
111. 111
112. 112
113. 113
114. 114
115. 115
116. 116
117. 117
118. 118
119. 119
120. 120

repo:
  # Directory containing git repositories to serve.
  scanPath: /var/www/git

  # Which filename will be treated as README file?
  # If a repository contains a file with exact matching filename to one from
  # this list, legit displays that file contents in repository top page.
  # When multiple files match (e.g. a repository having both `readme` and
  # `README.md`), the earlier one in the list will be shown.
  readme:
    - readme
    # Filenames are case-sensitive.
    - README
    # You have to provide file extensions.
    - readme.md
    - README.md

  # What branch will be considered default branch?
  # legit use default branch as a default ref for navigations.
  mainBranch:
    - master
    - main

# Runtime directories.
dirs:
  # [optional]
  # Path to a directory containing custom HTML templates.
  # Templates are written in Go's html/template syntax.
  # <https://pkg.go.dev/html/template>
  #
  # If you omit this, legit will use its default templates directory
  # ("templates" directory next to this file) embedded in the binary.
  templates: ./embed/templates

  # [optional]
  # Path to a directory containing custom static assets.
  # If you omit this, legit will use its default static asset directory
  # ("static" directory next to this file) embedded in the binary.
  #
  # Visitors can access files in this directory by accessing "/static/*".
  static: ./embed/static

meta:
  # Website's name.
  # Default: "Repositories"
  title: legit

  # Website's description.
  description: "web frontend for git repositories, written in Go"

  # Whether highlight repository's text file.
  # NOTE: This applies only to blob page. Code blocks inside README will be untouched.
  syntaxHighlight: true

ui:
  # Number of commits to display in a single "Commits" (log) page.
  commitsPageSize: 30

  # You can set repository's category by creating `category` file in $GIT_DIR or
  # setting `gitweb.category` git config.
  # https://git-scm.com/docs/gitweb#Documentation/gitweb.txt-categoryorgitwebcategory
  category:
    # Group repositories by category in top page. Default is `false`.
    grouping: true

    # Fallback name for repositories without category configured. If this value is empty,
    # uncategorized repositories will be listed at the top of repositories list, regardless
    # of the `order` option. Default value is empty string.
    default: "No Category"

    # By default, categories are sorted in alphabetical ascending order. You can
    # configure fixed ordering using this option. Categories not included in this
    # option will be put after this list in an alphabetical ascending order.
    order:
      - "Mirror"
      - "Demo"
      - "No Category"

  # Footer won't appear if `links` is empty and `poweredBy` is `false`.
  footer:
    # Links to display in the footer.
    links:
      - text: Contact
        # legit simply use this value as `<a>` tag's `href` attribute value.
        href: mailto:johndoe@example.com
      - text: Author Profile
        href: https://example.com

      # Display "Powered by ..." text.
    poweredBy: true

# Read and compile HTML templates on every request.
#
# By default, legit compiles HTML templates on server startup for performance
# reasons. This is great for most usecases but if you're customizing HTML
# templates, this can be tedious.
# 1) edit HTML template file
# 2) restart legit server
# 3) reload browser page
# You can skip step 2 by setting this option to `true`.
#
# Remember to turning off after customizing HTML templates. HTML templates
# compilation slows your pages response time.
compileTemplatesOnRequest: false

server:
  # [optional]
  # legit uses this strings for clone URL.
  # `https://<name>/<directory>`
  # In addition to hostname, you can include paths as well.
  # This will NOT affect how web server behaves.
  name: github.com/pocka

  # A host/hostname to bind web server to.
  # Default: "localhost"
  host: 0.0.0.0

  # TCP port legit's web server listens to.
  # Default: 5555
  port: 5555