mirror of
https://gitea.com/gitea/docs.git
synced 2026-07-22 02:37:42 +00:00
update branch in CI and docs (#15631)
This commit is contained in:
@@ -35,7 +35,7 @@ Again `gitea help` will allow you review this variable and you can override it u
|
|||||||
`--config` option on the `gitea` binary.
|
`--config` option on the `gitea` binary.
|
||||||
|
|
||||||
- [Quick Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/)
|
- [Quick Cheat Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/)
|
||||||
- [Complete List](https://github.com/go-gitea/gitea/blob/master/custom/conf/app.example.ini)
|
- [Complete List](https://github.com/go-gitea/gitea/blob/main/custom/conf/app.example.ini)
|
||||||
|
|
||||||
If the `CustomPath` folder can't be found despite checking `gitea help`, check the `GITEA_CUSTOM`
|
If the `CustomPath` folder can't be found despite checking `gitea help`, check the `GITEA_CUSTOM`
|
||||||
environment variable; this can be used to override the default path to something else.
|
environment variable; this can be used to override the default path to something else.
|
||||||
@@ -87,14 +87,14 @@ directory at the top of this document).
|
|||||||
Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
|
Every single page of Gitea can be changed. Dynamic content is generated using [go templates](https://golang.org/pkg/html/template/),
|
||||||
which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.
|
which can be modified by placing replacements below the `$GITEA_CUSTOM/templates` directory.
|
||||||
|
|
||||||
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).
|
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/main/templates) directory of Gitea source (Note: the example link is from the `main` branch. Make sure to use templates compatible with the release you are using).
|
||||||
|
|
||||||
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
|
Be aware that any statement contained inside `{{` and `}}` are Gitea's template syntax and
|
||||||
shouldn't be touched without fully understanding these components.
|
shouldn't be touched without fully understanding these components.
|
||||||
|
|
||||||
### Customizing startpage / homepage
|
### Customizing startpage / homepage
|
||||||
|
|
||||||
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`.
|
Copy [`home.tmpl`](https://github.com/go-gitea/gitea/blob/main/templates/home.tmpl) for your version of Gitea from `templates` to `$GITEA_CUSTOM/templates`.
|
||||||
Edit as you wish.
|
Edit as you wish.
|
||||||
Dont forget to restart your gitea to apply the changes.
|
Dont forget to restart your gitea to apply the changes.
|
||||||
|
|
||||||
@@ -113,7 +113,7 @@ For more information, see [Adding Legal Pages](https://docs.gitea.io/en-us/addin
|
|||||||
You can add new tabs in the same way, putting them in `extra_tabs.tmpl`.
|
You can add new tabs in the same way, putting them in `extra_tabs.tmpl`.
|
||||||
The exact HTML needed to match the style of other tabs is in the file
|
The exact HTML needed to match the style of other tabs is in the file
|
||||||
`templates/repo/header.tmpl`
|
`templates/repo/header.tmpl`
|
||||||
([source in GitHub](https://github.com/go-gitea/gitea/blob/master/templates/repo/header.tmpl))
|
([source in GitHub](https://github.com/go-gitea/gitea/blob/main/templates/repo/header.tmpl))
|
||||||
|
|
||||||
### Other additions to the page
|
### Other additions to the page
|
||||||
|
|
||||||
@@ -258,7 +258,7 @@ Then restart gitea and open a STL file on your gitea instance.
|
|||||||
|
|
||||||
The `$GITEA_CUSTOM/templates/mail` folder allows changing the body of every mail of Gitea.
|
The `$GITEA_CUSTOM/templates/mail` folder allows changing the body of every mail of Gitea.
|
||||||
Templates to override can be found in the
|
Templates to override can be found in the
|
||||||
[`templates/mail`](https://github.com/go-gitea/gitea/tree/master/templates/mail)
|
[`templates/mail`](https://github.com/go-gitea/gitea/tree/main/templates/mail)
|
||||||
directory of Gitea source.
|
directory of Gitea source.
|
||||||
Override by making a copy of the file under `$GITEA_CUSTOM/templates/mail` using a
|
Override by making a copy of the file under `$GITEA_CUSTOM/templates/mail` using a
|
||||||
full path structure matching source.
|
full path structure matching source.
|
||||||
@@ -282,7 +282,7 @@ To add custom .gitignore, add a file with existing [.gitignore rules](https://gi
|
|||||||
|
|
||||||
### Labels
|
### Labels
|
||||||
|
|
||||||
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`
|
To add a custom label set, add a file that follows the [label format](https://github.com/go-gitea/gitea/blob/main/options/label/Default) to `$GITEA_CUSTOM/options/label`
|
||||||
`#hex-color label name ; label description`
|
`#hex-color label name ; label description`
|
||||||
|
|
||||||
### Licenses
|
### Licenses
|
||||||
@@ -293,7 +293,7 @@ To add a custom license, add a file with the license text to `$GITEA_CUSTOM/opti
|
|||||||
|
|
||||||
Locales are managed via our [crowdin](https://crowdin.com/project/gitea).
|
Locales are managed via our [crowdin](https://crowdin.com/project/gitea).
|
||||||
You can override a locale by placing an altered locale file in `$GITEA_CUSTOM/options/locale`.
|
You can override a locale by placing an altered locale file in `$GITEA_CUSTOM/options/locale`.
|
||||||
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.
|
Gitea's default locale files can be found in the [`options/locale`](https://github.com/go-gitea/gitea/tree/main/options/locale) source folder and these should be used as examples for your changes.
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ from within the `$GOPATH`, hence the `go get` approach is no longer recommended.
|
|||||||
|
|
||||||
## Forking Gitea
|
## Forking Gitea
|
||||||
|
|
||||||
Download the master Gitea source code as above. Then, fork the
|
Download the main Gitea source code as above. Then, fork the
|
||||||
[Gitea repository](https://github.com/go-gitea/gitea) on GitHub,
|
[Gitea repository](https://github.com/go-gitea/gitea) on GitHub,
|
||||||
and either switch the git remote origin for your fork or add your fork as another remote:
|
and either switch the git remote origin for your fork or add your fork as another remote:
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ TAGS="bindata sqlite sqlite_unlock_notify" make build
|
|||||||
|
|
||||||
The `build` target will execute both `frontend` and `backend` sub-targets. If the `bindata` tag is present, the frontend files will be compiled into the binary. It is recommended to leave out the tag when doing frontend development so that changes will be reflected.
|
The `build` target will execute both `frontend` and `backend` sub-targets. If the `bindata` tag is present, the frontend files will be compiled into the binary. It is recommended to leave out the tag when doing frontend development so that changes will be reflected.
|
||||||
|
|
||||||
See `make help` for all available `make` targets. Also see [`.drone.yml`](https://github.com/go-gitea/gitea/blob/master/.drone.yml) to see how our continuous integration works.
|
See `make help` for all available `make` targets. Also see [`.drone.yml`](https://github.com/go-gitea/gitea/blob/main/.drone.yml) to see how our continuous integration works.
|
||||||
|
|
||||||
## Building continuously
|
## Building continuously
|
||||||
|
|
||||||
@@ -276,7 +276,7 @@ require `git lfs` to be installed. Other database tests are available but
|
|||||||
may need adjustment to the local environment.
|
may need adjustment to the local environment.
|
||||||
|
|
||||||
Look at
|
Look at
|
||||||
[`integrations/README.md`](https://github.com/go-gitea/gitea/blob/master/integrations/README.md)
|
[`integrations/README.md`](https://github.com/go-gitea/gitea/blob/main/integrations/README.md)
|
||||||
for more information and how to run a single test.
|
for more information and how to run a single test.
|
||||||
|
|
||||||
Our continuous integration will test the code passes its unit tests and that
|
Our continuous integration will test the code passes its unit tests and that
|
||||||
@@ -304,19 +304,19 @@ be cleaned up.
|
|||||||
|
|
||||||
A `launch.json` and `tasks.json` are provided within `contrib/ide/vscode` for
|
A `launch.json` and `tasks.json` are provided within `contrib/ide/vscode` for
|
||||||
Visual Studio Code. Look at
|
Visual Studio Code. Look at
|
||||||
[`contrib/ide/README.md`](https://github.com/go-gitea/gitea/blob/master/contrib/ide/README.md)
|
[`contrib/ide/README.md`](https://github.com/go-gitea/gitea/blob/main/contrib/ide/README.md)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
## Submitting PRs
|
## Submitting PRs
|
||||||
|
|
||||||
Once you're happy with your changes, push them up and open a pull request. It
|
Once you're happy with your changes, push them up and open a pull request. It
|
||||||
is recommended that you allow Gitea Managers and Owners to modify your PR
|
is recommended that you allow Gitea Managers and Owners to modify your PR
|
||||||
branches as we will need to update it to master before merging and/or may be
|
branches as we will need to update it to main before merging and/or may be
|
||||||
able to help fix issues directly.
|
able to help fix issues directly.
|
||||||
|
|
||||||
Any PR requires two approvals from the Gitea maintainers and needs to pass the
|
Any PR requires two approvals from the Gitea maintainers and needs to pass the
|
||||||
continous integration. Take a look at our
|
continous integration. Take a look at our
|
||||||
[`CONTRIBUTING.md`](https://github.com/go-gitea/gitea/blob/master/CONTRIBUTING.md)
|
[`CONTRIBUTING.md`](https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md)
|
||||||
document.
|
document.
|
||||||
|
|
||||||
If you need more help pop on to [Discord](https://discord.gg/gitea) #Develop
|
If you need more help pop on to [Discord](https://discord.gg/gitea) #Develop
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ repository data from other git host platforms to Gitea or, in the future, migrat
|
|||||||
git host platforms.
|
git host platforms.
|
||||||
Currently, migrations from Github, Gitlab, and other Gitea instances are implemented.
|
Currently, migrations from Github, Gitlab, and other Gitea instances are implemented.
|
||||||
|
|
||||||
First of all, Gitea defines some standard objects in packages [modules/migrations/base](https://github.com/go-gitea/gitea/tree/master/modules/migrations/base).
|
First of all, Gitea defines some standard objects in packages [modules/migrations/base](https://github.com/go-gitea/gitea/tree/main/modules/migrations/base).
|
||||||
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
|
They are `Repository`, `Milestone`, `Release`, `ReleaseAsset`, `Label`, `Issue`, `Comment`, `PullRequest`, `Reaction`, `Review`, `ReviewComment`.
|
||||||
|
|
||||||
## Downloader Interfaces
|
## Downloader Interfaces
|
||||||
@@ -31,11 +31,11 @@ To migrate from a new git host platform, there are two steps to be updated.
|
|||||||
- You should implement a `DownloaderFactory` which will be used to detect if the URL matches and create the above `Downloader`.
|
- You should implement a `DownloaderFactory` which will be used to detect if the URL matches and create the above `Downloader`.
|
||||||
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`.
|
- You'll need to register the `DownloaderFactory` via `RegisterDownloaderFactory` on `init()`.
|
||||||
|
|
||||||
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/master/modules/migrations/base/downloader.go).
|
You can find these interfaces in [downloader.go](https://github.com/go-gitea/gitea/blob/main/modules/migrations/base/downloader.go).
|
||||||
|
|
||||||
## Uploader Interface
|
## Uploader Interface
|
||||||
|
|
||||||
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded
|
Currently, only a `GiteaLocalUploader` is implemented, so we only save downloaded
|
||||||
data via this `Uploader` to the local Gitea instance. Other uploaders are not supported at this time.
|
data via this `Uploader` to the local Gitea instance. Other uploaders are not supported at this time.
|
||||||
|
|
||||||
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/master/modules/migrations/base/uploader.go).
|
You can find these interfaces in [uploader.go](https://github.com/go-gitea/gitea/blob/main/modules/migrations/base/uploader.go).
|
||||||
|
|||||||
@@ -54,8 +54,8 @@ git clone https://github.com/go-gitea/gitea
|
|||||||
no longer necessary.)
|
no longer necessary.)
|
||||||
|
|
||||||
Decide which version of Gitea to build and install. Currently, there are
|
Decide which version of Gitea to build and install. Currently, there are
|
||||||
multiple options to choose from. The `master` branch represents the current
|
multiple options to choose from. The `main` branch represents the current
|
||||||
development version. To build with master, skip to the [build section](#build).
|
development version. To build with main, skip to the [build section](#build).
|
||||||
|
|
||||||
To work with tagged releases, the following commands can be used:
|
To work with tagged releases, the following commands can be used:
|
||||||
|
|
||||||
@@ -89,7 +89,7 @@ To build from source, the following programs must be present on the system:
|
|||||||
- `node` {{< min-node-version >}} or higher with `npm`, see [here](https://nodejs.org/en/download/)
|
- `node` {{< min-node-version >}} or higher with `npm`, see [here](https://nodejs.org/en/download/)
|
||||||
- `make`, see <a href='{{< relref "doc/developers/hacking-on-gitea.en-us.md" >}}#installing-make'>here</a>
|
- `make`, see <a href='{{< relref "doc/developers/hacking-on-gitea.en-us.md" >}}#installing-make'>here</a>
|
||||||
|
|
||||||
Various [make tasks](https://github.com/go-gitea/gitea/blob/master/Makefile)
|
Various [make tasks](https://github.com/go-gitea/gitea/blob/main/Makefile)
|
||||||
are provided to keep the build process as simple as possible.
|
are provided to keep the build process as simple as possible.
|
||||||
|
|
||||||
Depending on requirements, the following build tags can be included.
|
Depending on requirements, the following build tags can be included.
|
||||||
|
|||||||
@@ -266,7 +266,7 @@ docker-compose up -d
|
|||||||
|
|
||||||
## Managing Deployments With Environment Variables
|
## Managing Deployments With Environment Variables
|
||||||
|
|
||||||
In addition to the environment variables above, any settings in `app.ini` can be set or overridden with an environment variable of the form: `GITEA__SECTION_NAME__KEY_NAME`. These settings are applied each time the docker container starts. Full information [here](https://github.com/go-gitea/gitea/tree/master/contrib/environment-to-ini).
|
In addition to the environment variables above, any settings in `app.ini` can be set or overridden with an environment variable of the form: `GITEA__SECTION_NAME__KEY_NAME`. These settings are applied each time the docker container starts. Full information [here](https://github.com/go-gitea/gitea/tree/main/contrib/environment-to-ini).
|
||||||
|
|
||||||
These environment variables can be passed to the docker container in `docker-compose.yml`. The following example will enable an smtp mail server if the required env variables `GITEA__mailer__FROM`, `GITEA__mailer__HOST`, `GITEA__mailer__PASSWD` are set on the host or in a `.env` file in the same directory as `docker-compose.yml`:
|
These environment variables can be passed to the docker container in `docker-compose.yml`. The following example will enable an smtp mail server if the required env variables `GITEA__mailer__FROM`, `GITEA__mailer__HOST`, `GITEA__mailer__PASSWD` are set on the host or in a `.env` file in the same directory as `docker-compose.yml`:
|
||||||
|
|
||||||
|
|||||||
@@ -96,7 +96,7 @@ See [#4286](https://github.com/go-gitea/gitea/issues/4286).
|
|||||||
|
|
||||||
## Add Gitea to startup on Unix
|
## Add Gitea to startup on Unix
|
||||||
|
|
||||||
Update the appropriate file from [gitea/contrib](https://github.com/go-gitea/gitea/tree/master/contrib)
|
Update the appropriate file from [gitea/contrib](https://github.com/go-gitea/gitea/tree/main/contrib)
|
||||||
with the right environment variables.
|
with the right environment variables.
|
||||||
|
|
||||||
For distros with systemd:
|
For distros with systemd:
|
||||||
|
|||||||
Reference in New Issue
Block a user