gitea/docs/content/doc/advanced/customizing-gitea.en-us.md
Alberto González Palomo 45c264f681 Templates for extra links in top navbar and repo tool tabs. (#3308)
These templates add content to the top navbar
and to the repository page.
This way we do not have to copy and modify the whole
template, and re-modify it after upgrading Gitea if
it changes.

Signed-off-by: Alberto González Palomo <bugs@sentido-labs.com>
2018-01-10 08:19:50 +02:00

2.9 KiB

date title slug weight toc draft menu
2017-04-15T14:56:00+02:00 Customizing Gitea customizing-gitea 9 false false
sidebar
parent name weight identifier
advanced Customizing Gitea 9 customizing-gitea

Customizing Gitea

Customizing Gitea is typically done using the custom folder. This is the central place to override configuration settings, templates, etc.

If Gitea is deployed from binary, all default paths will be relative to the gitea binary. If installed from a distribution, these paths will likely be modified to the Linux Filesystem Standard. Gitea will create required folders, including custom/. Application settings are configured in custom/conf/app.ini. Distributions may provide a symlink for custom using /etc/gitea/.

If the custom folder can't be found next to the binary, check the GITEA_CUSTOM environment variable; this can be used to override the default path to something else. GITEA_CUSTOM might, for example, be set by an init script.

Note: Gitea must perform a full restart to see configuration changes.

Customizing /robots.txt

To make Gitea serve a custom /robots.txt (default: empty 404), create a file called robots.txt in the custom folder with expected contents.

Serving custom public files

To make Gitea serve custom public files (like pages and images), use the folder custom/public/ as the webroot. Symbolic links will be followed.

For example, a file image.png stored in custom/public/, can be accessed with the url http://gitea.domain.tld/image.png.

Changing the default avatar

Place the png image at the following path: custom/public/img/avatar\_default.png

Customizing Gitea pages

The custom/templates folder allows changing every single page of Gitea. Templates to override can be found in the templates directory of Gitea source. Override by making a copy of the file under custom/templates using a full path structure matching source.

Any statement contained inside {{ and }} are Gitea's templete syntax and shouldn't be touched without fully understanding these components.

To add custom HTML to the header or the footer of the page, in the templates/custom directory there is header.tmpl and footer.tmpl that can be modified. This can be a useful place to add custom CSS files or additional Javascript.

If all you want is to add extra links to the top navigation bar, or extra tabs to the repository view, you can put them in extra_links.tmpl and extra_tabs.tmpl inside your custom/templates/custom/ directory.

Customizing gitignores, labels, licenses, locales, and readmes.

Place custom files in corresponding sub-folder under custom/options.