Skip to content
This repository has been archived by the owner on Dec 2, 2017. It is now read-only.

update the customizing section #100

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

update the customizing section #100

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0d38c6
update the customizing section
lunny Mar 11, 2017
2ad06c2
add the default custom folder
lunny Mar 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/doc/advanced/customizing-gitea.en-us.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ menu:

The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features.

## Specify the custom folder

The default custom folder is `GITEA_HOME/custom`, and you can set it by the env `GITEA_CUSTOM`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it GITEA_WORK_DIR instead of GITEA_HOME ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gah, confusing, gitea uses both GITEA_HOME and GITEA_WORK_DIR :(

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok now I see, it's only GITEA_WORK_DIR that is used by gitea. The GITEA_HOME variable is just internal variable for init scripts, so please update the patch.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@strk This should be documented somewhere. All the env vars get quite confusing.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@geek1011 see #111 - hopefully @blankoworld will take care of that (will you?)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will. I'm checking all os.Getenv in Gitea code and extract them. Then I list them on a page to explain what they do in the code. I will put the changes in #111, so that we can talk about it.

## 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`.
Expand All @@ -28,3 +32,11 @@ To make Gitea serve custom public files (like pages and images), use the folder
## Changing the default avatar

Place the png image at the following path: `custom/public/img/avatar_default.png`

## Customizing licenses/readme/locales/labels/gitignores

Put your customerize files into `custom/options/license`/`custom/options/readme/`/`custom/options/locale`/`custom/options/label/`/`custom/options/gitignore`

## Customizing templates

Put your template files on `custom/templates/`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in, not on.