You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/doc/advanced/customizing-gitea.en-us.md
+23-23Lines changed: 23 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ the Linux Filesystem Standard. Gitea will attempt to create required folders, in
30
30
`custom/`. Distributions may provide a symlink for `custom` using `/etc/gitea/`.
31
31
32
32
Application settings can be found in file `CustomConf` which is by default,
33
-
`CustomPath/conf/app.ini` but may be different if your build has set this differently.
33
+
`$GITEA_CUSTOM/conf/app.ini` but may be different if your build has set this differently.
34
34
Again `gitea help` will allow you review this variable and you can override it using the
35
35
`--config` option on the `gitea` binary.
36
36
@@ -53,15 +53,15 @@ is set under the "Configuration" tab on the site administration page.
53
53
## Serving custom public files
54
54
55
55
To make Gitea serve custom public files (like pages and images), use the folder
56
-
`CustomPath/public/` as the webroot. Symbolic links will be followed.
56
+
`$GITEA_CUSTOM/public/` as the webroot. Symbolic links will be followed.
57
57
58
-
For example, a file `image.png` stored in `CustomPath/public/`, can be accessed with
58
+
For example, a file `image.png` stored in `$GITEA_CUSTOM/public/`, can be accessed with
59
59
the url `http://gitea.domain.tld/image.png`.
60
60
61
61
## Changing the default logo
62
62
63
63
To build a custom logo replace `assets/logo.svg` and run `make generate-images`. This will update
64
-
these customizable logo files which you can then place in `CustomPath/public/img` on your server:
64
+
these customizable logo files which you can then place in `$GITEA_CUSTOM/public/img` on your server:
65
65
66
66
-`public/img/logo.svg`
67
67
-`public/img/logo.png`
@@ -73,19 +73,19 @@ these customizable logo files which you can then place in `CustomPath/public/img
73
73
74
74
Either generate it via above method or place the png image at the following path:
75
75
76
-
-`CustomPath/public/img/avatar_default.png`
76
+
-`$GITEA_CUSTOM/public/img/avatar_default.png`
77
77
78
78
## Customizing Gitea pages and resources
79
79
80
80
Gitea's executable contains all the resources required to run: templates, images, style-sheets
81
81
and translations. Any of them can be overridden by placing a replacement in a matching path
82
82
inside the `custom` directory. For example, to replace the default `.gitignore` provided
83
83
for C++ repositories, we want to replace `options/gitignore/C++`. To do this, a replacement
84
-
must be placed in `CustomPath/options/gitignore/C++` (see about the location of the `CustomPath`
84
+
must be placed in `$GITEA_CUSTOM/options/gitignore/C++` (see about the location of the `CustomPath`
85
85
directory at the top of this document).
86
86
87
87
Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
88
-
which can be modified by placing replacements below the `CustomPath/templates` directory.
88
+
which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.
89
89
90
90
To obtain any embedded file (including templates), the [`gitea embedded` tool]({{< relref "doc/advanced/cmd-embedded.en-us.md" >}}) can be used. Alternatively, they can be found in the [`templates`](https://github.com/go-gitea/gitea/tree/master/templates) directory of Gitea source (Note: the example link is from the `master` branch. Make sure to use templates compatible with the release you are using).
91
91
@@ -94,16 +94,16 @@ shouldn't be touched without fully understanding these components.
94
94
95
95
### Customizing startpage / homepage
96
96
97
-
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/master/templates/home.tmpl) for your version of Gitea from `templates` to `CustomPath/templates`.
97
+
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/master/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`.
98
98
Edit as you wish.
99
99
Dont forget to restart your gitea to apply the changes.
100
100
101
101
### Adding links and tabs
102
102
103
-
If all you want is to add extra links to the top navigation bar or footer, or extra tabs to the repository view, you can put them in `extra_links.tmpl` (links added to the navbar), `extra_links_footer.tmpl` (links added to the left side of footer), and `extra_tabs.tmpl` inside your `CustomPath/templates/custom/` directory.
103
+
If all you want is to add extra links to the top navigation bar or footer, or extra tabs to the repository view, you can put them in `extra_links.tmpl` (links added to the navbar), `extra_links_footer.tmpl` (links added to the left side of footer), and `extra_tabs.tmpl` inside your `$GITEA_CUSTOM/templates/custom/` directory.
104
104
105
105
For instance, let's say you are in Germany and must add the famously legally-required "Impressum"/about page, listing who is responsible for the site's content:
106
-
just place it under your "CustomPath/public/" directory (for instance `CustomPath/public/impressum.html`) and put a link to it in either `CustomPath/templates/custom/extra_links.tmpl` or `CustomPath/templates/custom/extra_links_footer.tmpl`.
106
+
just place it under your "$GITEA_CUSTOM/public/" directory (for instance `$GITEA_CUSTOM/public/impressum.html`) and put a link to it in either `$GITEA_CUSTOM/templates/custom/extra_links.tmpl` or `$GITEA_CUSTOM/templates/custom/extra_links_footer.tmpl`.
107
107
108
108
To match the current style, the link should have the class name "item", and you can use `{{AppSubUrl}}` to get the base URL:
@@ -117,7 +117,7 @@ The exact HTML needed to match the style of other tabs is in the file
117
117
118
118
### Other additions to the page
119
119
120
-
Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful templates you can put in your `CustomPath/templates/custom/` directory:
120
+
Apart from `extra_links.tmpl` and `extra_tabs.tmpl`, there are other useful templates you can put in your `$GITEA_CUSTOM/templates/custom/` directory:
121
121
122
122
-`header.tmpl`, just before the end of the `<head>` tag where you can add custom CSS files for instance.
123
123
-`body_outer_pre.tmpl`, right after the start of `<body>`.
@@ -133,7 +133,7 @@ The data is encoded and sent to the PlantUML server which generates the picture.
133
133
demo server at http://www.plantuml.com/plantuml, but if you (or your users) have sensitive data you
134
134
can set up your own [PlantUML server](https://plantuml.com/server) instead. To set up PlantUML rendering,
135
135
copy javascript files from https://gitea.com/davidsvantesson/plantuml-code-highlight and put them in your
136
-
`CustomPath/public` folder. Then add the following to `custom/footer.tmpl`:
136
+
`$GITEA_CUSTOM/public` folder. Then add the following to `custom/footer.tmpl`:
137
137
138
138
```html
139
139
{{if .RequireHighlightJS}}
@@ -202,15 +202,15 @@ You can display STL file directly in Gitea by adding:
202
202
203
203
to the file `templates/custom/footer.tmpl`
204
204
205
-
You also need to download the content of the library [Madeleine.js](https://jinjunho.github.io/Madeleine.js/) and place it under `CustomPath/public/` folder.
205
+
You also need to download the content of the library [Madeleine.js](https://jinjunho.github.io/Madeleine.js/) and place it under `$GITEA_CUSTOM/public/` folder.
206
206
207
207
You should end-up with a folder structucture similar to:
208
208
209
209
```
210
-
CustomPath/templates
210
+
$GITEA_CUSTOM/templates
211
211
-- custom
212
212
`-- footer.tmpl
213
-
CustomPath/public
213
+
$GITEA_CUSTOM/public
214
214
-- Madeleine.js
215
215
|-- LICENSE
216
216
|-- README.md
@@ -256,19 +256,19 @@ Then restart gitea and open a STL file on your gitea instance.
256
256
257
257
## Customizing Gitea mails
258
258
259
-
The `CustomPath/templates/mail` folder allows changing the body of every mail of Gitea.
259
+
The `$GITEA_CUSTOM/templates/mail` folder allows changing the body of every mail of Gitea.
Override by making a copy of the file under `CustomPath/templates/mail` using a
263
+
Override by making a copy of the file under `$GITEA_CUSTOM/templates/mail` using a
264
264
full path structure matching source.
265
265
266
266
Any statement contained inside `{{` and `}}` are Gitea's template
267
267
syntax and shouldn't be touched without fully understanding these components.
268
268
269
269
## Adding Analytics to Gitea
270
270
271
-
Google Analytics, Matomo (previously Piwik), and other analytics services can be added to Gitea. To add the tracking code, refer to the `Other additions to the page` section of this document, and add the JavaScript to the `CustomPath/templates/custom/header.tmpl` file.
271
+
Google Analytics, Matomo (previously Piwik), and other analytics services can be added to Gitea. To add the tracking code, refer to the `Other additions to the page` section of this document, and add the JavaScript to the `$GITEA_CUSTOM/templates/custom/header.tmpl` file.
272
272
273
273
## Customizing gitignores, labels, licenses, locales, and readmes.
274
274
@@ -278,21 +278,21 @@ Place custom files in corresponding sub-folder under `custom/options`.
278
278
279
279
### gitignores
280
280
281
-
To add custom .gitignore, add a file with existing [.gitignore rules](https://git-scm.com/docs/gitignore) in it to `CustomPath/options/gitignore`
281
+
To add custom .gitignore, add a file with existing [.gitignore rules](https://git-scm.com/docs/gitignore) in it to `$GITEA_CUSTOM/options/gitignore`
282
282
283
283
### Labels
284
284
285
-
To add a custom label set, add a file that follows the [label format](https://github.com/go-gitea/gitea/blob/master/options/label/Default) to `CustomPath/options/label`
285
+
To add a custom label set, add a file that follows the [label format](https://github.com/go-gitea/gitea/blob/master/options/label/Default) to `$GITEA_CUSTOM/options/label`
286
286
`#hex-color label name ; label description`
287
287
288
288
### Licenses
289
289
290
-
To add a custom license, add a file with the license text to `CustomPath/options/license`
290
+
To add a custom license, add a file with the license text to `$GITEA_CUSTOM/options/license`
291
291
292
292
### Locales
293
293
294
294
Locales are managed via our [crowdin](https://crowdin.com/project/gitea).
295
-
You can override a locale by placing an altered locale file in `CustomPath/options/locale`.
295
+
You can override a locale by placing an altered locale file in `$GITEA_CUSTOM/options/locale`.
296
296
Gitea's default locale files can be found in the [`options/locale`](https://github.com/go-gitea/gitea/tree/master/options/locale) source folder and these should be used as examples for your changes.
297
297
298
298
To add a completely new locale, as well as placing the file in the above location, you will need to add the new lang and name to the `[i18n]` section in your `app.ini`. Keep in mind that Gitea will use those settings as **overrides**, so if you want to keep the other languages as well you will need to copy/paste the default values and add your own to them.
@@ -307,7 +307,7 @@ Locales may change between versions, so keeping track of your customized locales
307
307
308
308
### Readmes
309
309
310
-
To add a custom Readme, add a markdown formatted file (without an `.md` extension) to `CustomPath/options/readme`
310
+
To add a custom Readme, add a markdown formatted file (without an `.md` extension) to `$GITEA_CUSTOM/options/readme`
311
311
312
312
**NOTE:** readme templates support **variable expansion**.
313
313
currently there are `{Name}` (name of repository), `{Description}`, `{CloneURL.SSH}`, `{CloneURL.HTTPS}` and `{OwnerName}`
0 commit comments