From e00fbbc85409ffd524b4ad0bf39d7ee2340da844 Mon Sep 17 00:00:00 2001 From: Yusef Maali Date: Sat, 15 Apr 2017 16:10:39 +0200 Subject: [PATCH] Update customizing-gitea.en-us.md --- .../doc/advanced/customizing-gitea.en-us.md | 24 ++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/content/doc/advanced/customizing-gitea.en-us.md b/content/doc/advanced/customizing-gitea.en-us.md index 98b73f8..6bb4ecd 100644 --- a/content/doc/advanced/customizing-gitea.en-us.md +++ b/content/doc/advanced/customizing-gitea.en-us.md @@ -1,5 +1,5 @@ --- -date: "2017-01-20T16:00:00+02:00" +date: "2017-04-15T14:56:00+02:00" title: "Customizing Gitea" slug: "customizing-gitea" weight: 9 @@ -17,14 +17,32 @@ menu: The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features. +If you installed Gitea from binary, you can find the `custom` folder next to the binary. +You should already find it, with a `conf` folder inside, where Gitea stores all the configuration settings provided through the installation steps. + ## Customizing /robots.txt -To make Gitea serve your own `/robots.txt` (by default, an empty 404 status is served), simply create a file called `robots.txt` in the `custom` folder with the [expected contents](http://www.robotstxt.org/). **Note** that you have to restart Gitea for it to notice the new `robots.txt`. +To make Gitea serve your own `/robots.txt` (by default, an empty 404 status is served), simply create a file called `robots.txt` in the `custom` folder with the [expected contents](http://www.robotstxt.org/). + +**Note** that you have to restart Gitea for it to notice the new `robots.txt`. ## 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 +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://your-gitea-url/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 you to change every single page of Gitea. + +You need to be aware of the template you want to change. All templates can be found in the `templates` folder of the Gitea sources. + +When you find the correct .tmpl file, you need to copy it in the `custom/templates` folder of your installation, __respecting__ any subfolder you found in the source template. + +You can now customize the template you copied in `custom/templates`, being carefully to not break the Gitea syntax. +Any statement contained inside `{{` and `}}` are Gitea templete's syntax and shouldn't be touch, unless you know what are you doing.