update the customizing section #100
Conversation
|
@tboerger please review |
|
LGTM |
|
|
||
| ## 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` |
There was a problem hiding this comment.
As you introduced GITEA_CUSTOM above, maybe this document could be consistent and use ${GITEA_CUSTOM} instead of just custom ?
There was a problem hiding this comment.
And maybe build an unordered list for the available customizations.
| @@ -17,6 +17,22 @@ menu: | |||
|
|
|||
| The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features. | |||
|
|
|||
| ## Specify my customerize folder | |||
|
|
|||
| Set the env `GITEA_CUSTOM`. | |||
There was a problem hiding this comment.
Specify that not setting it defaults to a custom directory and where such directory is resolved when relative (like in the default case)
| @@ -17,6 +17,22 @@ menu: | |||
|
|
|||
| The main way to customize Gitea is by using the `custom` folder. This is the central place to override and configure features. | |||
|
|
|||
| ## Specify my customerize folder | |||
There was a problem hiding this comment.
Change it to Specify the custom folder
|
|
||
| ## Customizing static files | ||
|
|
||
| Put your static files on `custom/public/` |
|
|
||
| ## Customizing templates | ||
|
|
||
| Put your template files on `custom/templates/` |
| ## Specify the custom folder | ||
|
|
||
| The default custom folder is `GITEA_HOME/custom`, and you can set it by the env `GITEA_CUSTOM`. | ||
|
|
There was a problem hiding this comment.
Isn't it GITEA_WORK_DIR instead of GITEA_HOME ?
There was a problem hiding this comment.
Gah, confusing, gitea uses both GITEA_HOME and GITEA_WORK_DIR :(
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@strk This should be documented somewhere. All the env vars get quite confusing.
There was a problem hiding this comment.
@geek1011 see #111 - hopefully @blankoworld will take care of that (will you?)
There was a problem hiding this comment.
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 templates | ||
|
|
||
| Put your template files on `custom/templates/` |
As title.