Compare commits

...

92 commits

Author SHA1 Message Date
Twenty Panda
7e60f058d1 user: actions: add examples to the cache 2024-06-22 20:25:39 +00:00
b2c12f3897 user: issue-tracking-basics: correct some parts 2024-06-22 20:01:57 +00:00
Shiny Nematoda
9a59b851f3 Add screenshots for code search (#715)
reflect changes made in forgejo/forgejo#4134

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/715
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Shiny Nematoda <snematoda.751k2@aleeas.com>
Co-committed-by: Shiny Nematoda <snematoda.751k2@aleeas.com>
2024-06-22 20:01:14 +00:00
0ko
9383360c7c Developer: improve Weblate announcement information 2024-06-18 09:52:54 +05:00
982e8fd215 user: issue-tracking-basics: update screenshot (#716)
Updates the screenshot in the issue tracking basics page, as it looks very dated (even shows the old Codeberg logo)

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/716
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Ikuyo Kita <kitakita@disroot.org>
Co-committed-by: Ikuyo Kita <kitakita@disroot.org>
2024-06-16 13:46:01 +00:00
2d76e3a32c
admin: CLI: add F3 sub-command 2024-06-16 10:22:49 +02:00
0ko
edd4728e04 developer: corrections for base localization management 2024-06-14 20:07:53 +05:00
7c3b81ec99
user: first-repository: update screenshots and content 2024-06-14 16:13:27 +08:00
9pfs
b362696091 Fix typo (bookwork -> bookworm) 2024-06-14 03:52:46 +00:00
3a88278ae8 developer: infrastructure: EX101 with a ASRockRack only 2024-06-13 19:59:49 +00:00
11859284af user: oauth2: illustrated example to add an authentication source (#703)
Preview: https://forgejo.codeberg.page/@docs_pull_703/docs/next/user/oauth2-provider/#using-a-codeberg-as-an-authentication-source
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/703
Reviewed-by: twenty-panda <twenty-panda@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-06-13 15:33:51 +00:00
d718114a48 developer: infrastructure: read-only backpups of gna.org
For discussions related to Forgejo hosting services.

Refs: https://codeberg.org/forgejo/discussions/issues/72
2024-06-11 19:04:09 +00:00
16834531f1
admin: storage: add missing MINIO_CHECKSUM_ALGORITHM setting
Fixes: https://codeberg.org/forgejo/forgejo/issues/4103
2024-06-11 17:37:05 +02:00
2cebfa7231 developer: infrastructure: DRBD disaster recovery instructions
One step is missing when restarting the machine, which happened today
because of a network card failure.
2024-06-09 10:56:20 +00:00
444cba3f20 developer: dependencies: do not require a label for each dependency
it is extra work and does not provide anything searching for past pull
requests with the same title would not.
2024-06-09 07:10:11 +00:00
0ko
faa6814244 Fix lint & a little English improvement 2024-06-08 12:36:57 +00:00
mirko
bc38574257 Add APP_SLOGAN config 2024-06-08 14:06:12 +02:00
da4e314547 developer: dependencies: how to tune software upgrades 2024-06-08 07:56:47 +00:00
0222f4a502 add example config for neovim 2024-06-08 07:45:45 +00:00
6fa1c28677 user: actions: document the default for shell
`jobs.<job_id>.steps[*].shell` defaults to `bash` unless
`jobs.<job_id>.container.image` is specified in which case it defaults
to `sh`.

Refs: https://code.forgejo.org/forgejo/runner/issues/150
2024-06-08 04:58:24 +00:00
e400655e1c
developer: infrastructure: DRBD speedup trick
used while re-imaging hetzner01 to be the secondary of hetzner04
2024-06-03 14:31:13 +02:00
cd1507419f Fixes and updates installation-docker.md (#645)
Makes a minor correction to which is the next version number.

Also includes information about the `7.0` docker tag's versioning based on facts the author only can recall seeing on Matrix but currently cannot actually find direct proof of such messages existence for reference now.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/645
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-03 07:19:31 +00:00
c86099d84e
Updates whitelist to allowlist 2024-06-01 21:26:59 -04:00
a0a49c54b9 Updates installation steps (#632)
Applies standard running list sentence formatting.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/632
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-06-01 14:09:43 +00:00
Abdur-Rahman Mansoor
f2e3723bd3
style: fix more typos in /docs/admin 2024-05-31 16:47:58 -04:00
f8288ff9ff Updates installation.md (#631)
Adds a link to the releases management section in  `installation.md`.

Preview https://forgejo.codeberg.page/@docs_pull_631/docs/next/admin/installation/

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/631
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-31 13:41:56 +00:00
8ba517004d Fixes broken links (#675)
Preview: https://forgejo.codeberg.page/@docs_pull_675/docs/next/user/first-repository/

Redirect links as reported:

https://codeberg.org/forgejo/docs/issues/674
https://codeberg.org/forgejo/docs/issues/673
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/675
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-31 11:50:41 +00:00
f9c4ad9e0b
developer: infrastructure: hosting {lab,cloud}.forgefriends.org 2024-05-31 10:18:42 +02:00
1a8ed80ebd developer: infrastructure: hosting forum.forgefriends.org 2024-05-30 09:53:26 +00:00
f2ad71255d
developer: secrets: link to gopass deb packages
I could not figure out where they are located from the install
instructions of gopass. It is implied but not explicit.
2024-05-30 09:34:52 +02:00
d141e54597 Modifies and reformats actions.md glossary (#630)
Adds contents to the glossary section of the `actions.md` file.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/630
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-30 05:54:01 +00:00
Abdur-Rahman Mansoor
c37e8619d6
style: fix lots of typos in installation-binary.md 2024-05-29 20:32:54 -04:00
e7a037e4fe
developer: static-pages: setup forgefriends.org
Refs: https://codeberg.org/forgejo/discussions/issues/114
2024-05-29 15:43:34 +02:00
5df2f0d0d3
developer: infrastructure: deploy a runner for forgefriends
Refs: https://codeberg.org/forgejo/discussions/issues/114
2024-05-29 08:59:34 +02:00
6b6f79e6ff user: actions: indent issue 2024-05-28 20:58:30 +00:00
ee6d19ca3f developer: infrastructure: document hetzner04 and rework everything
The page grew over the past year to have redundancies and
inconsistencies. It is organized to keep sections that are common to
all machines in one place:

* LXC container creation
* Forgejo runner creation
* DRBD
* vSwitch

The other sections are unified (Disk partitioning).
2024-05-28 20:58:14 +00:00
9326746c38 Adds consistency to sentence formatting in seek-assistance.md (#633)
Places `.` symbol at the end of a couple of list sentences.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/633
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adagio <h759bkyo4@mozmail.com>
Co-committed-by: adagio <h759bkyo4@mozmail.com>
2024-05-28 10:47:19 +00:00
Abdur-Rahman Mansoor
d35b4548d1 style: fix typos in /docs/admin (#656)
Now that I've finished `/docs/user`  I suppose I will start working on `/docs/admin`. I didn't change all the files at once since I thought it would be annoying for the maintainers to review. If you prefer I make all the changes at once, feel free to let me know and I would be happy to do that as well. :)

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/656
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Reviewed-by: Caesar Schinas <caesar@caesarschinas.com>
Co-authored-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
Co-committed-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
2024-05-27 23:52:48 +00:00
Schiriki
c46f6bc4af
Replace gitea through forgejo 2024-05-28 00:21:02 +02:00
77e3e1205f developer: infrastructure: static pages hosting
Run a LXC container that hosts static pages.

* manual one time configuration (web server configuration, git clone
  of content)
* webhook based pull for updates

It is created to host the F3 documentation. It can be used in the
future to host the Forgejo website and retire Uberspace.

Refs: https://codeberg.org/forgejo/governance/issues/36
Refs: https://forgejo.org/docs/v7.0/developer/infrastructure/#uberspace
Refs: https://codeberg.org/forgejo/discussions/issues/114
2024-05-26 21:36:04 +00:00
Abdur-Rahman Mansoor
ed5886012a style: fix more typos in /docs/user 2024-05-26 10:47:47 +00:00
518407ccfe
admin: command-line: update
scripts/cli-docs.sh run next > docs/admin/command-line.md
2024-05-26 11:35:45 +02:00
Abdur-Rahman Mansoor
5c52eddd34 style: fix typos and use american spelling convention in some areas (#647)
You'll notice that asides from some typo fixes, "organisation" has been changed to "organization" to ensure a more consistent style guide, adapted to Codeberg's style: https://docs.codeberg.org/improving-documentation/style-guide/

Also changed "orgs" to "organizations" as it's more professional and easier to understand.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/647
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
Co-committed-by: Abdur-Rahman Mansoor <armansoor@missingno.dev>
2024-05-25 14:28:28 +00:00
dc67b3c83a admin: installation: rootless data is in /var/lib/gitea by default
Refs: https://codeberg.org/forgejo/forgejo/issues/3869
2024-05-25 12:34:14 +00:00
5c634782b9
Add guide to set branch to push to AGit pull request by default 2024-05-25 10:37:46 +01:00
cd43c8b018 Docker installation detail fixes (#643)
Updates and fixes version descriptions for the latest Forgejo Docker image.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/643
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-05-24 07:50:39 +00:00
27118e60fe Updates localization.md (#642)
Continues progress made in: https://codeberg.org/forgejo/docs/pulls/469

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/642
Reviewed-by: 0ko <0ko@noreply.codeberg.org>
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-05-24 06:02:10 +00:00
Victoria Nadasdi
6b73e7411e
fix: pin node packageManager
As packageManager is not pinned, `pnpm install --frozen-lockfile` will
install the latest version and adds it to the `package.json` file.

That makes PR checks fail because it checks if there are any changes
(`diff`) in the working directory as a step.
2024-05-22 15:05:30 +02:00
Shiny Nematoda
970f8a24f0 update code search (forgejo/forgejo#3654) 2024-05-17 10:44:54 +00:00
8a28a4db15 developer: dependency: release notes example 2024-05-16 21:14:53 +00:00
a09cea8876 developer: compiling requires go v1.22 not v1.21 2024-05-16 21:05:37 +00:00
0ko
a83db24507 Replace Knut source link with IA 2024-05-16 19:30:20 +05:00
f5b51da942 adds and updates hierarchy section 2024-05-16 07:40:42 +00:00
2821d3cec4
admin: command-line: add actions-artifacts option
scripts/cli-docs.sh run next > docs/admin/command-line.md

Refs: https://codeberg.org/forgejo/forgejo/pulls/3772
2024-05-15 20:08:51 +02:00
b6b99c0b55 Add Caddy config to reverse proxy section (#605)
Added Caddy example configs, turned on syntax highlighting in nginx/apache

Closes: forgejo/website#232
Reviewed-on: https://codeberg.org/forgejo/docs/pulls/605
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-05-14 23:07:03 +00:00
0ko
fb73fd507d Localization: add instructions for fixing various failures with Weblate CL 2024-05-14 22:32:31 +00:00
Crown0815
720667cf04 Fix incorrect default value in CheatSheet for attachment MaxSize
I tested my forgejo instance and it says that it cannot upload files larger than 2048 MB.
I also confirmed on the gitea cheatsheet where the value is also 2048 MB
(see https://docs.gitea.com/administration/config-cheat-sheet#issue-and-pull-request-attachments-attachment)
2024-05-14 10:00:38 +00:00
a9beec6523 Updates Contributing section of the README (#611)
Adds content to the Contributing section of the README.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/611
Reviewed-by: oliverpool <oliverpool@noreply.codeberg.org>
Co-authored-by: adbagio <h759bkyo4@mozmail.com>
Co-committed-by: adbagio <h759bkyo4@mozmail.com>
2024-05-13 10:21:31 +00:00
jwildeboer
784e395e97 Update Issue/PR Template doc (#609)
Preview: https://forgejo.codeberg.page/@docs_pull_609/docs/next/user/issue-pull-request-templates/#directory-names

Proposal based on https://codeberg.org/forgejo/docs/issues/607 to make the docs more readable and add the `.forgejo` directory. Also added the `ref` and `labels` options to the yaml example.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/609
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: jwildeboer <jwildeboer@noreply.codeberg.org>
Co-committed-by: jwildeboer <jwildeboer@noreply.codeberg.org>
2024-05-12 18:43:11 +00:00
Kwonunn
c1b7969c1d Reverse Proxy setup guide (#600)
I've added a more comprehensive guide to set up Reverse Proxies.

So far I've added nginx configuration, I'm also planning to add apache configuration later on.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/600
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Kwonunn <kwonunnx@gmail.com>
Co-committed-by: Kwonunn <kwonunnx@gmail.com>
2024-05-10 07:22:19 +00:00
359caf8476 admin(actions): the latest stable runner is 3.4.1 2024-05-10 07:19:38 +00:00
cascading-pr
131300c912 cascading-pr update 2024-05-10 05:39:23 +00:00
38c90ce5d6 developer(infrastructure): ubuntu-runner.forgejo.org 2024-05-07 10:54:55 +00:00
5acda1e0b2 developer: release: cut the documentation branch
- add a checklist to the release instructions
- use a pattern for push instead of an explicit list of branches
  it was previously advisable to avoid conflicts when there was
  no automated backports but it is no longer necessary
2024-05-07 10:53:58 +00:00
5471e62e60 Exclude links (#595)
Added excludes for some site errors. Added issue update on fail

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/595
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: TheFox0x7 <thefox0x7@gmail.com>
Co-committed-by: TheFox0x7 <thefox0x7@gmail.com>
2024-05-06 21:18:46 +00:00
d597a359c2 drop action in favor of plain script 2024-05-05 15:03:52 +00:00
Yaroslav Halchenko
9ad5f2ab0f Add codespell support (without CI) and make it fix some typos (#536)
Per "request" of @0ko in https://codeberg.org/forgejo/forgejo/pulls/3270#issuecomment-1774032

TODOs
- postponed: how to add codespell (written in Python) to CI -- separate workflow? add to some other step? to some other tool/specification?

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/536
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Yaroslav Halchenko <debian@onerussian.com>
Co-committed-by: Yaroslav Halchenko <debian@onerussian.com>
2024-05-05 14:53:04 +00:00
0ko
4cba3d36b3 Fix dead links 2024-05-05 06:18:43 +00:00
3c38f063d4
add lychee action 2024-05-04 14:11:19 +02:00
OniriCorpe
cd06bf37c5 Fix the 'Forgejo numbering scheme' link 2024-05-02 23:52:48 +00:00
alydev
0bfc31bd0a
SSL note for minio storage, fixed dead link 2024-05-01 18:33:10 +10:00
2a12684354
admin(cli): update 2024-04-30 17:37:19 +02:00
d9c4a8bd18 admin: upgrade: drop issue.created when upgrading from gogs
Refs: https://codeberg.org/forgejo/forgejo/issues/3488
2024-04-28 20:37:17 +00:00
bea94cd9bd Revert "Add rootless installation instructions"
This reverts commit 345765e21f.
2024-04-28 20:36:03 +00:00
Firepup650
a1106f2fce Fix a broken link
`[clean up job]../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages)` -> `[clean up job](../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages)`
2024-04-28 14:55:54 +00:00
Robin Kloppe
d9db0d13f6 Added Repo Mirros (#568)
In a next step https://codeberg.org/forgejo/forgejo/pulls/3503 can be merged

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/568
Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org>
Co-authored-by: Robin Kloppe <git@mainboarder.de>
Co-committed-by: Robin Kloppe <git@mainboarder.de>
2024-04-28 08:58:32 +00:00
Otto Richter
c6c39005b0 Document database.MAX_OPEN_CONNS limit
See https://codeberg.org/forgejo/forgejo/pulls/3500
and https://codeberg.org/forgejo/forgejo/pulls/3383
for details.
2024-04-27 22:39:00 +02:00
cascading-pr
ef11b41eb5 cascading-pr update 2024-04-25 13:40:26 +00:00
0ko
bcd7348a70 localization admin: add Weblate announcement 2024-04-24 18:58:31 +05:00
a0477a8300 LTS: is not part of the metadata & CLI updates (#561)
- LTS are listed in the table, no hint in the version number
- update the RC release names
- CLI updates

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/561
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-04-23 15:57:31 +00:00
cd3c76c05d docs: user: new section on comment on issues & PR via email 2024-04-23 09:03:49 +00:00
6aa9b491a0 sync with Gitea e865de1e9d65dc09797d165a51c8e705d2a86030
cd docs
git diff d3982bcd814bac93e3cbce1c7eb749b17e413fbd..e865de1e9d65dc09797d165a51c8e705d2a86030 -- $(find . -type f -name '*en-us*')
2024-04-23 07:16:10 +00:00
88ea9f3a24
meta: pnpm has a new format for lockfiles
Seem to be better to upgrade despite it being very new rather than
to pin pnpm.
2024-04-23 01:01:32 +02:00
06233a63cd developer: release: octopuce is not publicly visible 2024-04-21 07:03:44 +00:00
51a1f2951e developer: infrastructure: v7.next.forgejo.org 2024-04-21 06:52:09 +00:00
0ko
82ab0bb31b developer: update localization admin guides 2024-04-21 06:49:58 +00:00
crystal
2a91eef705 prerelease version docs 2024-04-21 06:47:51 +00:00
Otto Richter
7c8c649cc9 Sync list of default themes
See https://codeberg.org/forgejo/forgejo/pulls/1746
2024-04-21 06:47:08 +00:00
crystal
d58d729c58
fix 404 2024-04-20 16:59:47 -06:00
4ce64e2840 docs: pick the Forgejo release from experimental (#542)
in the case of a release that is not yet published, it will exist as
release candidates in the experimental organization. Every release go
through there and it is a reliable source.

Reviewed-on: https://codeberg.org/forgejo/docs/pulls/542
Reviewed-by: crystal <crystal@noreply.codeberg.org>
Co-authored-by: Earl Warren <contact@earl-warren.org>
Co-committed-by: Earl Warren <contact@earl-warren.org>
2024-04-20 08:39:14 +00:00
crystal
bd8e4e588a timetzdata is in the release build tags 2024-04-20 07:26:55 +00:00
c11ee8a32d
the v7.0 branch is cut 2024-04-20 08:25:54 +02:00
116 changed files with 3249 additions and 1986 deletions

7
.codespellrc Normal file
View file

@ -0,0 +1,7 @@
[codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = .git*,*-lock.yaml,.codespellrc
check-hidden = true
# ALLWAYS - ALL WAYS, config variable
ignore-regex = \bALLWAYS\b
# ignore-words-list =

View file

@ -0,0 +1,35 @@
name: Links
on:
schedule:
- cron: '00 18 * * *'
jobs:
linkChecker:
runs-on: docker
steps:
- name: Checkout next
uses: actions/checkout@v4
- name: Checkout v7
uses: actions/checkout@v4
with:
path: v7
- name: Install lychee
run: |
curl -sLO "https://github.com/lycheeverse/lychee/releases/download/v0.15.0/lychee-v0.15.0-x86_64-unknown-linux-gnu.tar.gz"
tar -xvzf "lychee-v0.15.0-x86_64-unknown-linux-gnu.tar.gz"
rm "lychee-v0.15.0-x86_64-unknown-linux-gnu.tar.gz"
install -t "$HOME/.local/bin" -D lychee
- name: Link Checker
id: lychee
run: ./lychee docs v7/docs --format markdown
- name: Update issue
if: failure()
uses: https://github.com/peter-evans/create-issue-from-file@v5.0.0
with:
title: Dead links report
issue-number: 583
content-filepath: ./report.md

View file

@ -4,9 +4,7 @@ on:
push:
branches:
- 'next'
- 'v1.21'
- 'v1.20'
- 'v1.19'
- 'v*'
jobs:
publish:

View file

@ -13,6 +13,7 @@ a new branch will be created in this repo to document the stable release.
Current release branches are as follows:
- [`next`](https://codeberg.org/forgejo/docs/src/branch/next)
- [`v7.0`](https://codeberg.org/forgejo/docs/src/branch/v7.0)
- [`v1.21`](https://codeberg.org/forgejo/docs/src/branch/v1.21)
- [`v1.20`](https://codeberg.org/forgejo/docs/src/branch/v1.20)
- [`v1.19`](https://codeberg.org/forgejo/docs/src/branch/v1.19)
@ -21,6 +22,10 @@ Documentation content lives in the `docs` directory, and images in the `docs/_im
## Contributing
There are many ways to contribute to improving the Forgejo documentation
including reviewing the current information, making suggestions for
improvement or reporting bugs.
### Tooling
It is possible to simply edit the documentation with a text editor and [send PRs](#pull-requests) without using any other tooling.
@ -82,7 +87,7 @@ pnpm run lint
```
Prettier is also able to automatically format the code according to its rules.
To do so, ue the following command.
To do so, use the following command.
Be aware that it can occasionally break things, so be sure to check what it changes.
```shell
@ -110,7 +115,7 @@ Most changes should either be sent as a _single commit per PR_, or should be squ
_Fast-forwarding is the preferred merge strategy._
Changes can then be [backported](#backports) (or if appropriate frontported) by cherry-picking.
Rarely, it will make sense to create a feature branch containting a series of commits that will
Rarely, it will make sense to create a feature branch containing a series of commits that will
be merged instead of squashing and fast-forwarding.
Such a feature branch can then be merged into multiple versions of the docs if appropriate.
In this case, the feature branch should usually be taken from the last common ancestor of all of the
@ -119,7 +124,7 @@ version branches into which it will potentially be merged.
#### Backports
If a PR is meant to be backported to a stable branch, it must be
labelled with `backport/v1.20`, `backport/v1.19`, etc.
labelled with `backport/v7.0`, `backport/v1.21`, etc.
### Content guidelines

Binary file not shown.

After

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

After

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.5 KiB

After

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 201 KiB

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 87 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

View file

@ -94,9 +94,9 @@ Each `Forgejo runner` release is published for all supported architectures as:
Download the latest [binary release](https://code.forgejo.org/forgejo/runner/releases) and verify its signature:
```shell
$ wget -O forgejo-runner https://code.forgejo.org/forgejo/runner/releases/download/v3.3.0/forgejo-runner-3.3.0-linux-amd64
$ wget -O forgejo-runner https://code.forgejo.org/forgejo/runner/releases/download/v3.4.1/forgejo-runner-3.4.1-linux-amd64
$ chmod +x forgejo-runner
$ wget -O forgejo-runner.asc https://code.forgejo.org/forgejo/runner/releases/download/v3.3.0/forgejo-runner-3.3.0-linux-amd64.asc
$ wget -O forgejo-runner.asc https://code.forgejo.org/forgejo/runner/releases/download/v3.4.1/forgejo-runner-3.4.1-linux-amd64.asc
$ gpg --keyserver keys.openpgp.org --recv EB114F5E6C0DC2BCDD183550A4B61A2DC5923710
$ gpg --verify forgejo-runner.asc forgejo-runner
Good signature from "Forgejo <contact@forgejo.org>"
@ -111,14 +111,14 @@ are built from the Dockerfile which is [found in the source
directory](https://code.forgejo.org/forgejo/runner/src/branch/main/Dockerfile). It contains the `forgejo-runner` binary.
```shell
$ docker run --rm code.forgejo.org/forgejo/runner:3.3.0 forgejo-runner --version
forgejo-runner version v3.3.0
$ docker run --rm code.forgejo.org/forgejo/runner:3.4.1 forgejo-runner --version
forgejo-runner version v3.4.1
```
It does not run as root:
```shell
$ docker run --rm code.forgejo.org/forgejo/runner:3.3.0 id
$ docker run --rm code.forgejo.org/forgejo/runner:3.4.1 id
uid=1000 gid=1000 groups=1000
```
@ -158,7 +158,7 @@ services:
restart: 'unless-stopped'
gitea:
image: 'code.forgejo.org/forgejo/runner:3.3.0'
image: 'code.forgejo.org/forgejo/runner:3.4.1'
links:
- docker-in-docker
depends_on:
@ -178,7 +178,7 @@ services:
Here, we're not running the `forgejo-runner daemon` yet because we
need to register it first. Please note that in a recent install of
docker `docker-compose`is not a separate command but should be run as
docker `docker-compose` is not a separate command but should be run as
`docker compose`.
Follow the registration instructions below
by starting the `runner` service with `docker-compose up -d` and
@ -218,7 +218,7 @@ environment. They need to be installed and configured independently.
(because it doesn't usually need one).
If the Forgejo runner complains about "daemon Docker Engine socket not found", or "cannot ping the docker daemon",
you can use podman to provide a Docker compatible socket from an unprivileged user
you can use Podman to provide a Docker compatible socket from an unprivileged user
and pass that socket on to the runner,
e.g. by executing:
@ -245,7 +245,7 @@ environment. They need to be installed and configured independently.
```shell
$ lxc-helpers.sh lxc_container_run forgejo-runners -- sudo --user debian bash
$ sudo apt-get install docker.io wget gnupg2
$ wget -O forgejo-runner https://code.forgejo.org/forgejo/runner/releases/download/v3.3.0/forgejo-runner-amd64
$ wget -O forgejo-runner https://code.forgejo.org/forgejo/runner/releases/download/v3.4.1/forgejo-runner-amd64
...
```
@ -275,7 +275,7 @@ The `Forgejo runner` needs to connect to a `Forgejo` instance and must be regist
```shell
forgejo-runner register --no-interactive --token {TOKEN} --name runner --instance https://next.forgejo.org
INFO Registering runner, arch=amd64, os=linux, version=3.3.0.
INFO Registering runner, arch=amd64, os=linux, version=3.4.1.
INFO Runner registered successfully.
```
@ -379,7 +379,7 @@ runner:
# The labels of a runner are used to determine which jobs the runner can run, and how to run them.
# Like: ["macos-arm64:host", "ubuntu-latest:docker://node:16-bullseye", "ubuntu-22.04:docker://node:16-bullseye"]
# If it's empty when registering, it will ask for inputting labels.
# If it's empty when execute `deamon`, will use labels in `.runner` file.
# If it's empty when execute `daemon`, will use labels in `.runner` file.
labels: []
cache:
@ -532,7 +532,7 @@ jobs:
If you run this action with `forgejo-runner exec`, you should expect this job fail:
```shell-session
```shellsession
$ forgejo-runner exec
...
| curl: (7) Couldn't connect to server
@ -595,7 +595,7 @@ will have the `Forgejo runner` declare that it supports the `node20` and `bullse
If the list of labels is empty, it defaults to `docker:docker://node:16-bullseye` and will declare the label `docker`.
Declaring a label means that the `Forgejo runner` will accept tasks that specify this label in the `runs-on` field.
So, to mimick the GitHub runners, the `runs-on` field can be set to `ubuntu-22.04:docker://node:20-bullseye` for instance.
So, to mimic the GitHub runners, the `runs-on` field can be set to `ubuntu-22.04:docker://node:20-bullseye` for instance.
With this, the Forgejo runner will respond to `runs-on: ubuntu-22.04` and will use the `node:20-bullseye` image from hub.docker.com.
This image is quite capable of running many of the workflows that are designed for the GitHub runners.
For a slightly bigger image, use `ghcr.io/catthehacker/ubuntu:act-22.04` instead of `node:20-bullseye` which should be compatible with most actions while remaining relatively small.
@ -629,7 +629,7 @@ They can be overridden by a workflow to use `debian` and `bookworm` as follows.
```yaml
runs-on: lxc
container:
image: debian:bookwork
image: debian:bookworm
```
See the user documentation for `jobs.<job_id>.container` for more information.

View file

@ -15,32 +15,33 @@ To update this page, run the following command from the root of the docs repo:
```
NAME:
Forgejo - Beyond coding. We forge.
forgejo - Beyond coding. We forge.
USAGE:
Forgejo [global options] command [command options] [arguments...]
forgejo [global options] command [command options]
DESCRIPTION:
By default, forgejo will start serving using the web-server with no argument, which can alternatively be run by running the subcommand "web".
COMMANDS:
help, h Shows a list of commands or help for one command
web Start the Forgejo web server
serv This command should only be called by SSH shell
hook Delegate commands to corresponding Git hooks
serv (internal) Should only be called by SSH shell
hook (internal) Should only be called by Git
keys (internal) Should only be called by SSH server
dump Dump Forgejo files and database
admin Command line interface to perform common administrative operations
admin Perform common administrative operations
migrate Migrate the database
keys This command queries the Forgejo database to get the authorized command for a given ssh key fingerprint
doctor Diagnose and optionally fix problems
doctor Diagnose and optionally fix problems, convert or re-create database tables
manager Manage the running forgejo process
embedded Extract embedded resources
migrate-storage Migrate the storage
dump-repo Dump the repository from git/github/gitea/gitlab
restore-repo Restore the repository from disk
help, h Shows a list of commands or help for one command
actions Manage Forgejo Actions
cert Generate self-signed certificate
generate Command line interface for running generators
generate Generate Gitea's secrets/keys/tokens
docs Output CLI documentation
forgejo-cli Forgejo CLI
@ -56,13 +57,14 @@ GLOBAL OPTIONS:
```
NAME:
Forgejo forgejo-cli - Forgejo CLI
forgejo forgejo-cli - Forgejo CLI
USAGE:
Forgejo forgejo-cli command [command options] [arguments...]
forgejo forgejo-cli command [command options]
COMMANDS:
actions Commands for managing Forgejo Actions
f3 F3
help, h Shows a list of commands or help for one command
OPTIONS:
@ -73,10 +75,10 @@ OPTIONS:
```
NAME:
Forgejo forgejo-cli actions - Commands for managing Forgejo Actions
forgejo forgejo-cli actions - Commands for managing Forgejo Actions
USAGE:
Forgejo forgejo-cli actions command [command options] [arguments...]
forgejo forgejo-cli actions command [command options]
COMMANDS:
generate-runner-token Generate a new token for a runner to use to register with the server
@ -92,10 +94,10 @@ OPTIONS:
```
NAME:
Forgejo forgejo-cli actions generate-runner-token - Generate a new token for a runner to use to register with the server
forgejo forgejo-cli actions generate-runner-token - Generate a new token for a runner to use to register with the server
USAGE:
Forgejo forgejo-cli actions generate-runner-token [command options] [arguments...]
forgejo forgejo-cli actions generate-runner-token [command options]
OPTIONS:
--scope value, -s value {owner}[/{repo}] - leave empty for a global runner
@ -106,10 +108,10 @@ OPTIONS:
```
NAME:
Forgejo forgejo-cli actions generate-secret - Generate a secret suitable for input to the register subcommand
forgejo forgejo-cli actions generate-secret - Generate a secret suitable for input to the register subcommand
USAGE:
Forgejo forgejo-cli actions generate-secret [command options] [arguments...]
forgejo forgejo-cli actions generate-secret [command options]
OPTIONS:
--help, -h show help
@ -119,10 +121,10 @@ OPTIONS:
```
NAME:
Forgejo forgejo-cli actions register - Idempotent registration of a runner using a shared secret
forgejo forgejo-cli actions register - Idempotent registration of a runner using a shared secret
USAGE:
Forgejo forgejo-cli actions register [command options] [arguments...]
forgejo forgejo-cli actions register [command options]
OPTIONS:
--secret value the secret the runner will use to connect as a 40 character hexadecimal string
@ -135,14 +137,31 @@ OPTIONS:
--help, -h show help
```
### forgejo-cli f3
```
NAME:
forgejo forgejo-cli f3 - F3
USAGE:
forgejo forgejo-cli f3 command [command options]
COMMANDS:
mirror Mirror
help, h Shows a list of commands or help for one command
OPTIONS:
--help, -h show help
```
## web
```
NAME:
Forgejo web - Start the Forgejo web server
forgejo web - Start the Forgejo web server
USAGE:
Forgejo web command [command options] [arguments...]
forgejo web command [command options]
DESCRIPTION:
The Forgejo web server is the only thing you need to run,
@ -167,10 +186,10 @@ OPTIONS:
```
NAME:
Forgejo dump - Dump Forgejo files and database
forgejo dump - Dump Forgejo files and database
USAGE:
Forgejo dump command [command options] [arguments...]
forgejo dump command [command options]
DESCRIPTION:
Dump compresses all related files and database into zip file.
@ -188,7 +207,7 @@ OPTIONS:
--verbose, -V Show process details (default: false)
--quiet, -q Only display warnings and errors (default: false)
--tempdir value, -t value Temporary dir path (default: "/tmp")
--database value, -d value Specify the database SQL syntax: sqlite3, mysql, mssql, postgres
--database value, -d value Specify the database SQL syntax: sqlite3, mysql, postgres
--skip-repository, -R Skip the repository dumping (default: false)
--skip-log, -L Skip the log dumping (default: false)
--skip-custom-dir Skip custom directory (default: false)
@ -203,10 +222,10 @@ OPTIONS:
```
NAME:
Forgejo admin - Command line interface to perform common administrative operations
forgejo admin - Perform common administrative operations
USAGE:
Forgejo admin command [command options] [arguments...]
forgejo admin command [command options]
COMMANDS:
user Modify users
@ -227,10 +246,10 @@ OPTIONS:
```
NAME:
Forgejo admin user - Modify users
forgejo admin user - Modify users
USAGE:
Forgejo admin user command [command options] [arguments...]
forgejo admin user command [command options]
COMMANDS:
create Create a new user in database
@ -252,10 +271,10 @@ OPTIONS:
```
NAME:
Forgejo admin user create - Create a new user in database
forgejo admin user create - Create a new user in database
USAGE:
Forgejo admin user create command [command options] [arguments...]
forgejo admin user create command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -271,7 +290,7 @@ OPTIONS:
--email value User email address
--admin User is an admin (default: false)
--random-password Generate a random password for the user (default: false)
--must-change-password Set this option to false to prevent forcing the user to change their password after initial login, (Default: true) (default: false)
--must-change-password Set this option to false to prevent forcing the user to change their password after initial login
--random-password-length value Length of the random password to be generated (default: 12)
--access-token Generate access token for the user (default: false)
--restricted Make a restricted user account (default: false)
@ -281,10 +300,10 @@ OPTIONS:
```
NAME:
Forgejo admin user list - List users
forgejo admin user list - List users
USAGE:
Forgejo admin user list command [command options] [arguments...]
forgejo admin user list command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -301,10 +320,10 @@ OPTIONS:
```
NAME:
Forgejo admin user change-password - Change a user's password
forgejo admin user change-password - Change a user's password
USAGE:
Forgejo admin user change-password command [command options] [arguments...]
forgejo admin user change-password command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -316,16 +335,17 @@ OPTIONS:
--work-path value, -w value Set Forgejo's working path (defaults to the directory of the Forgejo binary)
--username value, -u value The user to change password for
--password value, -p value New password to set for user
--must-change-password User must change password (default: true)
```
### admin user delete
```
NAME:
Forgejo admin user delete - Delete specific user by id, name or email
forgejo admin user delete - Delete specific user by id, name or email
USAGE:
Forgejo admin user delete command [command options] [arguments...]
forgejo admin user delete command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -345,10 +365,10 @@ OPTIONS:
```
NAME:
Forgejo admin user generate-access-token - Generate an access token for a specific user
forgejo admin user generate-access-token - Generate an access token for a specific user
USAGE:
Forgejo admin user generate-access-token command [command options] [arguments...]
forgejo admin user generate-access-token command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -368,10 +388,10 @@ OPTIONS:
```
NAME:
Forgejo admin user must-change-password - Set the must change password flag for the provided users or all users
forgejo admin user must-change-password - Set the must change password flag for the provided users or all users
USAGE:
Forgejo admin user must-change-password command [command options] [arguments...]
forgejo admin user must-change-password command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -390,10 +410,10 @@ OPTIONS:
```
NAME:
Forgejo admin repo-sync-releases - Synchronize repository releases with tags
forgejo admin repo-sync-releases - Synchronize repository releases with tags
USAGE:
Forgejo admin repo-sync-releases command [command options] [arguments...]
forgejo admin repo-sync-releases command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -409,10 +429,10 @@ OPTIONS:
```
NAME:
Forgejo admin regenerate - Regenerate specific files
forgejo admin regenerate - Regenerate specific files
USAGE:
Forgejo admin regenerate command [command options] [arguments...]
forgejo admin regenerate command [command options]
COMMANDS:
hooks Regenerate git-hooks
@ -430,10 +450,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth - Modify external auth providers
forgejo admin auth - Modify external auth providers
USAGE:
Forgejo admin auth command [command options] [arguments...]
forgejo admin auth command [command options]
COMMANDS:
add-oauth Add new Oauth authentication source
@ -459,10 +479,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth add-oauth - Add new Oauth authentication source
forgejo admin auth add-oauth - Add new Oauth authentication source
USAGE:
Forgejo admin auth add-oauth command [command options] [arguments...]
forgejo admin auth add-oauth command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -499,10 +519,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth update-oauth - Update existing Oauth authentication source
forgejo admin auth update-oauth - Update existing Oauth authentication source
USAGE:
Forgejo admin auth update-oauth command [command options] [arguments...]
forgejo admin auth update-oauth command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -540,10 +560,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth add-ldap - Add new LDAP (via Bind DN) authentication source
forgejo admin auth add-ldap - Add new LDAP (via Bind DN) authentication source
USAGE:
Forgejo admin auth add-ldap command [command options] [arguments...]
forgejo admin auth add-ldap command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -584,10 +604,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth update-ldap - Update existing LDAP (via Bind DN) authentication source
forgejo admin auth update-ldap - Update existing LDAP (via Bind DN) authentication source
USAGE:
Forgejo admin auth update-ldap command [command options] [arguments...]
forgejo admin auth update-ldap command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -629,10 +649,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth add-ldap-simple - Add new LDAP (simple auth) authentication source
forgejo admin auth add-ldap-simple - Add new LDAP (simple auth) authentication source
USAGE:
Forgejo admin auth add-ldap-simple command [command options] [arguments...]
forgejo admin auth add-ldap-simple command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -661,17 +681,17 @@ OPTIONS:
--public-ssh-key-attribute value The attribute of the users LDAP record containing the users public ssh key.
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
--avatar-attribute value The attribute of the users LDAP record containing the users avatar.
--user-dn value The users DN.
--user-dn value The user's DN.
```
### admin auth update-ldap-simple
```
NAME:
Forgejo admin auth update-ldap-simple - Update existing LDAP (simple auth) authentication source
forgejo admin auth update-ldap-simple - Update existing LDAP (simple auth) authentication source
USAGE:
Forgejo admin auth update-ldap-simple command [command options] [arguments...]
forgejo admin auth update-ldap-simple command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -701,17 +721,17 @@ OPTIONS:
--public-ssh-key-attribute value The attribute of the users LDAP record containing the users public ssh key.
--skip-local-2fa Set to true to skip local 2fa for users authenticated by this source (default: false)
--avatar-attribute value The attribute of the users LDAP record containing the users avatar.
--user-dn value The users DN.
--user-dn value The user's DN.
```
### admin auth add-smtp
```
NAME:
Forgejo admin auth add-smtp - Add new SMTP authentication source
forgejo admin auth add-smtp - Add new SMTP authentication source
USAGE:
Forgejo admin auth add-smtp command [command options] [arguments...]
forgejo admin auth add-smtp command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -738,10 +758,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth update-smtp - Update existing SMTP authentication source
forgejo admin auth update-smtp - Update existing SMTP authentication source
USAGE:
Forgejo admin auth update-smtp command [command options] [arguments...]
forgejo admin auth update-smtp command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -769,10 +789,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth list - List auth sources
forgejo admin auth list - List auth sources
USAGE:
Forgejo admin auth list command [command options] [arguments...]
forgejo admin auth list command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -793,10 +813,10 @@ OPTIONS:
```
NAME:
Forgejo admin auth delete - Delete specific auth source
forgejo admin auth delete - Delete specific auth source
USAGE:
Forgejo admin auth delete command [command options] [arguments...]
forgejo admin auth delete command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -813,10 +833,10 @@ OPTIONS:
```
NAME:
Forgejo admin sendmail - Send a message to all users
forgejo admin sendmail - Send a message to all users
USAGE:
Forgejo admin sendmail command [command options] [arguments...]
forgejo admin sendmail command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -835,10 +855,10 @@ OPTIONS:
```
NAME:
Forgejo migrate - Migrate the database
forgejo migrate - Migrate the database
USAGE:
Forgejo migrate command [command options] [arguments...]
forgejo migrate command [command options]
DESCRIPTION:
This is a command for migrating the database, so that you can run gitea admin create-user before starting the server.
@ -857,10 +877,13 @@ OPTIONS:
```
NAME:
Forgejo keys - This command queries the Forgejo database to get the authorized command for a given ssh key fingerprint
forgejo keys - (internal) Should only be called by SSH server
USAGE:
Forgejo keys command [command options] [arguments...]
forgejo keys command [command options]
DESCRIPTION:
Queries the Forgejo database to get the authorized command for a given ssh key fingerprint
COMMANDS:
help, h Shows a list of commands or help for one command
@ -880,10 +903,10 @@ OPTIONS:
```
NAME:
Forgejo doctor - Diagnose and optionally fix problems
forgejo doctor - Diagnose and optionally fix problems, convert or re-create database tables
USAGE:
Forgejo doctor command [command options] [arguments...]
forgejo doctor command [command options]
DESCRIPTION:
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
@ -905,10 +928,10 @@ OPTIONS:
```
NAME:
Forgejo doctor check - Diagnose and optionally fix problems
forgejo doctor check - Diagnose and optionally fix problems
USAGE:
Forgejo doctor check command [command options] [arguments...]
forgejo doctor check command [command options]
DESCRIPTION:
A command to diagnose problems with the current Forgejo instance according to the given configuration. Some problems can optionally be fixed by modifying the database or data storage.
@ -934,10 +957,10 @@ OPTIONS:
```
NAME:
Forgejo doctor recreate-table - Recreate tables from XORM definitions and copy the data.
forgejo doctor recreate-table - Recreate tables from XORM definitions and copy the data.
USAGE:
Forgejo doctor recreate-table command [command options] [TABLE]... : (TABLEs to recreate - leave blank for all)
forgejo doctor recreate-table command [command options] [TABLE]... : (TABLEs to recreate - leave blank for all)
DESCRIPTION:
The database definitions Forgejo uses change across versions, sometimes changing default values and leaving old unused columns.
@ -961,13 +984,13 @@ OPTIONS:
```
NAME:
Forgejo doctor convert - Convert the database
forgejo doctor convert - Convert the database
USAGE:
Forgejo doctor convert command [command options] [arguments...]
forgejo doctor convert command [command options]
DESCRIPTION:
A command to convert an existing MySQL database from utf8 to utf8mb4 or MSSQL database from varchar to nvarchar
A command to convert an existing MySQL database from utf8 to utf8mb4
COMMANDS:
help, h Shows a list of commands or help for one command
@ -983,10 +1006,10 @@ OPTIONS:
```
NAME:
Forgejo manager - Manage the running forgejo process
forgejo manager - Manage the running forgejo process
USAGE:
Forgejo manager command [command options] [arguments...]
forgejo manager command [command options]
DESCRIPTION:
This is a command for managing the running forgejo process
@ -1011,10 +1034,10 @@ OPTIONS:
```
NAME:
Forgejo manager shutdown - Gracefully shutdown the running process
forgejo manager shutdown - Gracefully shutdown the running process
USAGE:
Forgejo manager shutdown command [command options] [arguments...]
forgejo manager shutdown command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1031,10 +1054,10 @@ OPTIONS:
```
NAME:
Forgejo manager restart - Gracefully restart the running process - (not implemented for windows servers)
forgejo manager restart - Gracefully restart the running process - (not implemented for windows servers)
USAGE:
Forgejo manager restart command [command options] [arguments...]
forgejo manager restart command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1051,10 +1074,10 @@ OPTIONS:
```
NAME:
Forgejo manager reload-templates - Reload template files in the running process
forgejo manager reload-templates - Reload template files in the running process
USAGE:
Forgejo manager reload-templates command [command options] [arguments...]
forgejo manager reload-templates command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1071,10 +1094,10 @@ OPTIONS:
```
NAME:
Forgejo manager flush-queues - Flush queues in the running process
forgejo manager flush-queues - Flush queues in the running process
USAGE:
Forgejo manager flush-queues command [command options] [arguments...]
forgejo manager flush-queues command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1093,10 +1116,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging - Adjust logging commands
forgejo manager logging - Adjust logging commands
USAGE:
Forgejo manager logging command [command options] [arguments...]
forgejo manager logging command [command options]
COMMANDS:
pause Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
@ -1118,10 +1141,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging pause - Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
forgejo manager logging pause - Pause logging (Forgejo will buffer logs up to a certain point and will drop them after that point)
USAGE:
Forgejo manager logging pause command [command options] [arguments...]
forgejo manager logging pause command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1138,10 +1161,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging resume - Resume logging
forgejo manager logging resume - Resume logging
USAGE:
Forgejo manager logging resume command [command options] [arguments...]
forgejo manager logging resume command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1158,10 +1181,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging release-and-reopen - Cause Forgejo to release and re-open files used for logging
forgejo manager logging release-and-reopen - Cause Forgejo to release and re-open files used for logging
USAGE:
Forgejo manager logging release-and-reopen command [command options] [arguments...]
forgejo manager logging release-and-reopen command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1178,10 +1201,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging remove - Remove a logger
forgejo manager logging remove - Remove a logger
USAGE:
Forgejo manager logging remove command [command options] [name] Name of logger to remove
forgejo manager logging remove command [command options] [name] Name of logger to remove
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1199,10 +1222,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging add - Add a logger
forgejo manager logging add - Add a logger
USAGE:
Forgejo manager logging add command [command options] [arguments...]
forgejo manager logging add command [command options]
COMMANDS:
file Add a file logger
@ -1220,10 +1243,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging add file - Add a file logger
forgejo manager logging add file - Add a file logger
USAGE:
Forgejo manager logging add file command [command options] [arguments...]
forgejo manager logging add file command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1255,10 +1278,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging add conn - Add a net conn logger
forgejo manager logging add conn - Add a net conn logger
USAGE:
Forgejo manager logging add conn command [command options] [arguments...]
forgejo manager logging add conn command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1287,10 +1310,10 @@ OPTIONS:
```
NAME:
Forgejo manager logging log-sql - Set LogSQL
forgejo manager logging log-sql - Set LogSQL
USAGE:
Forgejo manager logging log-sql command [command options] [arguments...]
forgejo manager logging log-sql command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1308,10 +1331,10 @@ OPTIONS:
```
NAME:
Forgejo manager processes - Display running processes within the current process
forgejo manager processes - Display running processes within the current process
USAGE:
Forgejo manager processes command [command options] [arguments...]
forgejo manager processes command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1333,10 +1356,10 @@ OPTIONS:
```
NAME:
Forgejo embedded - Extract embedded resources
forgejo embedded - Extract embedded resources
USAGE:
Forgejo embedded command [command options] [arguments...]
forgejo embedded command [command options]
DESCRIPTION:
A command for extracting embedded resources, like templates and images
@ -1358,10 +1381,10 @@ OPTIONS:
```
NAME:
Forgejo embedded list - List files matching the given pattern
forgejo embedded list - List files matching the given pattern
USAGE:
Forgejo embedded list command [command options] [arguments...]
forgejo embedded list command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1378,10 +1401,10 @@ OPTIONS:
```
NAME:
Forgejo embedded view - View a file matching the given pattern
forgejo embedded view - View a file matching the given pattern
USAGE:
Forgejo embedded view command [command options] [arguments...]
forgejo embedded view command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1398,10 +1421,10 @@ OPTIONS:
```
NAME:
Forgejo embedded extract - Extract resources
forgejo embedded extract - Extract resources
USAGE:
Forgejo embedded extract command [command options] [arguments...]
forgejo embedded extract command [command options]
COMMANDS:
help, h Shows a list of commands or help for one command
@ -1422,10 +1445,10 @@ OPTIONS:
```
NAME:
Forgejo migrate-storage - Migrate the storage
forgejo migrate-storage - Migrate the storage
USAGE:
Forgejo migrate-storage command [command options] [arguments...]
forgejo migrate-storage command [command options]
DESCRIPTION:
Copies stored files from storage configured in app.ini to parameter-configured storage
@ -1438,7 +1461,7 @@ OPTIONS:
--custom-path value, -C value Set custom path (defaults to '{WorkPath}/custom')
--config value, -c value Set custom config file (defaults to '{WorkPath}/custom/conf/app.ini')
--work-path value, -w value Set Forgejo's working path (defaults to the directory of the Forgejo binary)
--type value, -t value Type of stored files to copy. Allowed types: 'attachments', 'lfs', 'avatars', 'repo-avatars', 'repo-archivers', 'packages', 'actions-log'
--type value, -t value Type of stored files to copy. Allowed types: 'attachments', 'lfs', 'avatars', 'repo-avatars', 'repo-archivers', 'packages', 'actions-log', 'actions-artifacts'
--storage value, -s value New storage type: local (default) or minio
--path value, -p value New storage placement if store is local (leave blank for default)
--minio-endpoint value Minio storage endpoint
@ -1456,10 +1479,10 @@ OPTIONS:
```
NAME:
Forgejo dump-repo - Dump the repository from git/github/gitea/gitlab
forgejo dump-repo - Dump the repository from git/github/gitea/gitlab
USAGE:
Forgejo dump-repo command [command options] [arguments...]
forgejo dump-repo command [command options]
DESCRIPTION:
This is a command for dumping the repository data.
@ -1488,10 +1511,10 @@ OPTIONS:
```
NAME:
Forgejo restore-repo - Restore the repository from disk
forgejo restore-repo - Restore the repository from disk
USAGE:
Forgejo restore-repo command [command options] [arguments...]
forgejo restore-repo command [command options]
DESCRIPTION:
This is a command for restoring the repository data.
@ -1516,10 +1539,10 @@ OPTIONS:
```
NAME:
Forgejo cert - Generate self-signed certificate
forgejo cert - Generate self-signed certificate
USAGE:
Forgejo cert [command options] [arguments...]
forgejo cert [command options]
DESCRIPTION:
Generate a self-signed X.509 certificate for a TLS server.
@ -1539,10 +1562,10 @@ OPTIONS:
```
NAME:
Forgejo generate secret - Generate a secret token
forgejo generate secret - Generate a secret token
USAGE:
Forgejo generate secret command [command options] [arguments...]
forgejo generate secret command [command options]
COMMANDS:
INTERNAL_TOKEN Generate a new INTERNAL_TOKEN

View file

@ -1,7 +1,7 @@
---
title: 'Configuration Cheat Sheet'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/config-cheat-sheet.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/config-cheat-sheet.en-us.md'
---
This is a cheat sheet for the Forgejo configuration file. It contains most of the settings
@ -55,6 +55,9 @@ In addition, there is _`StaticRootPath`_ which can be set as a built-in at build
## Overall (`DEFAULT`)
- `APP_NAME`: **Forgejo: Beyond coding. We forge.**: Application name, used in the page title.
- `APP_SLOGAN`: Application slogan, used in the page title.
- `APP_DISPLAY_NAME_FORMAT`: **{APP_NAME}: {APP_SLOGAN}**: defines how the application full name should be presented.
It is only used if `APP_SLOGAN` is set.
- `RUN_USER`: **_current OS username_/`$USER`/`$USERNAME` e.g. git**: The user Forgejo will run as.
This should be a dedicated system (non-user) account. Setting this incorrectly will cause Forgejo
to not start.
@ -209,10 +212,10 @@ The following configuration set `Content-Type: application/vnd.android.package-a
- `CODE_COMMENT_LINES`: **4**: Number of line of codes shown for a code comment.
- `DEFAULT_THEME`: **forgejo-auto**: \[forgejo-auto, forgejo-light, forgejo-dark, auto, gitea, arc-green\]: Set the default theme for the Forgejo install.
- `SHOW_USER_EMAIL`: **true**: Whether the email of the user should be shown in the Explore Users page.
- `THEMES`: **forgejo-auto,forgejo-light,forgejo-dark,auto,gitea,arc-green**: All available themes. Allow users select personalized themes.
- `THEMES`: **forgejo-auto, forgejo-light, forgejo-dark, gitea-auto, gitea-light, gitea-dark, forgejo-auto-deuteranopia-protanopia, forgejo-light-deuteranopia-protanopia, forgejo-dark-deuteranopia-protanopia, forgejo-auto-tritanopia, forgejo-light-tritanopia, forgejo-dark-tritanopia**: All available themes. Allow users select personalized themes.
regardless of the value of `DEFAULT_THEME`.
- `MAX_DISPLAY_FILE_SIZE`: **8388608**: Max size of files to be displayed (default is 8MiB)
- `REACTIONS`: All available reactions users can choose on issues/prs and comments
- `REACTIONS`: All available reactions users can choose on issues/PRs and comments
Values can be emoji alias (:smile:) or a unicode emoji.
For custom reactions, add a tightly cropped square image to public/assets/img/emoji/reaction_name.png
- `REACTION_MAX_USER_NUM`: **10**: Change the number of users that are displayed in reactions tooltip (triggered by mouse hover).
@ -406,15 +409,15 @@ The following configuration set `Content-Type: application/vnd.android.package-a
- Aliased names
- "ecdhe_rsa_with_chacha20_poly1305" is an alias for "ecdhe_rsa_with_chacha20_poly1305_sha256"
- "ecdhe_ecdsa_with_chacha20_poly1305" is alias for "ecdhe_ecdsa_with_chacha20_poly1305_sha256"
- `ENABLE_ACME`: **false**: Flag to enable automatic certificate management via an ACME capable Certificate Authority (CA) server (default: Lets Encrypt). If enabled, `CERT_FILE` and `KEY_FILE` are ignored, and the CA must resolve `DOMAIN` to this forgejo server. Ensure that DNS records are set and either port `80` or port `443` are accessible by the CA server (the public internet by default), and redirected to the appropriate ports `PORT_TO_REDIRECT` or `HTTP_PORT` respectively.
- `ACME_URL`: **\<empty\>**: The CA's ACME directory URL, e.g. for a self-hosted [smallstep CA server](https://github.com/smallstep/certificates), it can look like `https://ca.example.com/acme/acme/directory`. If left empty, it defaults to using Let's Encerypt's production CA (check `LETSENCRYPT_ACCEPTTOS` as well).
- `ACME_ACCEPTTOS`: **false**: This is an explicit check that you accept the terms of service of the ACME provider. The default is Lets Encrypt [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
- `ENABLE_ACME`: **false**: Flag to enable automatic certificate management via an ACME capable Certificate Authority (CA) server (default: Let's Encrypt). If enabled, `CERT_FILE` and `KEY_FILE` are ignored, and the CA must resolve `DOMAIN` to this Forgejo server. Ensure that DNS records are set and either port `80` or port `443` are accessible by the CA server (the public internet by default), and redirected to the appropriate ports `PORT_TO_REDIRECT` or `HTTP_PORT` respectively.
- `ACME_URL`: **\<empty\>**: The CA's ACME directory URL, e.g. for a self-hosted [smallstep CA server](https://github.com/smallstep/certificates), it can look like `https://ca.example.com/acme/acme/directory`. If left empty, it defaults to using Let's Encrypt's production CA (check `LETSENCRYPT_ACCEPTTOS` as well).
- `ACME_ACCEPTTOS`: **false**: This is an explicit check that you accept the terms of service of the ACME provider. The default is Let's Encrypt [terms of service](https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf).
- `ACME_DIRECTORY`: **https**: Directory that the certificate manager will use to cache information such as certs and private keys.
- `ACME_EMAIL`: **\<empty\>**: Email used for the ACME registration. Usually it is to notify about problems with issued certificates.
- `ACME_CA_ROOT`: **\<empty\>**: The CA's root certificate. If left empty, it defaults to using the system's trust chain.
- `ALLOW_GRACEFUL_RESTARTS`: **true**: Perform a graceful restart on SIGHUP
- `GRACEFUL_HAMMER_TIME`: **60s**: After a restart the parent process will stop accepting new connections and will allow requests to finish before stopping. Shutdown will be forced if it takes longer than this time.
- `STARTUP_TIMEOUT`: **0**: Shutsdown the server if startup takes longer than the provided time. On Windows setting this sends a waithint to the SVC host to tell the SVC host startup may take some time. Please note startup is determined by the opening of the listeners - HTTP/HTTPS/SSH. Indexers may take longer to startup and can have their own timeouts.
- `STARTUP_TIMEOUT`: **0**: Shuts down the server if startup takes longer than the provided time. On Windows setting this sends a waithint to the SVC host to tell the SVC host startup may take some time. Please note startup is determined by the opening of the listeners - HTTP/HTTPS/SSH. Indexers may take longer to startup and can have their own timeouts.
## Database (`database`)
@ -446,7 +449,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a
- `LOG_SQL`: **false**: Log the executed SQL.
- `DB_RETRIES`: **10**: How many ORM init / DB connect attempts allowed.
- `DB_RETRY_BACKOFF`: **3s**: time.Duration to wait before trying another ORM init / DB connect attempt, if failure occurred.
- `MAX_OPEN_CONNS` **0**: Database maximum open connections - default is 0, meaning there is no limit.
- `MAX_OPEN_CONNS` **100**: Database maximum open connections. Default is 100 which is the lowest default from Postgres (MariaDB + MySQL default to 151). Setting this value higher than your database server can handle will lead to issues. If you require high concurrency, try to increase this value for both Forgejo and your database server.
- `MAX_IDLE_CONNS` **2**: Max idle database connections on connection pool, default is 2 - this will be capped to `MAX_OPEN_CONNS`.
- `CONN_MAX_LIFETIME` **0 or 3s**: Sets the maximum amount of time a DB connection may be reused - default is 0, meaning there is no limit (except on MySQL/MariaDB where it is 3s - see #6804 & #7071).
- `CONN_MAX_IDLETIME` **0**: Sets the maximum amount of time a DB connection may be idle - default is 0, meaning there is no limit.
@ -484,9 +487,9 @@ Configuration at `[queue]` will set defaults for queues with overrides for indiv
- `DATADIR`: **queues/common**: Base DataDir for storing level queues. `DATADIR` for individual queues can be set in `queue.name` sections. Relative paths will be made absolute against `%(APP_DATA_PATH)s`.
- `LENGTH`: **100000**: Maximal queue size before channel queues block
- `BATCH_LENGTH`: **20**: Batch data before passing to the handler
- `CONN_STR`: **redis://127.0.0.1:6379/0**: Connection string for the redis queue type. For `redis-cluster` use `redis+cluster://127.0.0.1:6379/0`. Options can be set using query params. Similarly, LevelDB options can also be set using: **leveldb://relative/path?option=value** or **leveldb:///absolute/path?option=value**, and will override `DATADIR`
- `QUEUE_NAME`: **\_queue**: The suffix for default redis and disk queue name. Individual queues will default to **`name`**`QUEUE_NAME` but can be overridden in the specific `queue.name` section.
- `SET_NAME`: **\_unique**: The suffix that will be added to the default redis and disk queue `set` name for unique queues. Individual queues will default to **`name`**`QUEUE_NAME`_`SET_NAME`_ but can be overridden in the specific `queue.name` section.
- `CONN_STR`: **redis://127.0.0.1:6379/0**: Connection string for the Redis queue type. For `redis-cluster` use `redis+cluster://127.0.0.1:6379/0`. Options can be set using query params. Similarly, LevelDB options can also be set using: **leveldb://relative/path?option=value** or **leveldb:///absolute/path?option=value**, and will override `DATADIR`
- `QUEUE_NAME`: **\_queue**: The suffix for default Redis and disk queue name. Individual queues will default to **`name`**`QUEUE_NAME` but can be overridden in the specific `queue.name` section.
- `SET_NAME`: **\_unique**: The suffix that will be added to the default Redis and disk queue `set` name for unique queues. Individual queues will default to **`name`**`QUEUE_NAME`_`SET_NAME`_ but can be overridden in the specific `queue.name` section.
- `MAX_WORKERS`: **(dynamic)**: Maximum number of worker go-routines for the queue. Default value is "CpuNum/2" clipped to between 1 and 10.
Forgejo creates the following non-unique queues:
@ -509,8 +512,14 @@ And the following unique queues:
- `DEFAULT_EMAIL_NOTIFICATIONS`: **enabled**: Default configuration for email notifications for users (user configurable). Options: enabled, onmention, disabled
- `DISABLE_REGULAR_ORG_CREATION`: **false**: Disallow regular (non-admin) users from creating organizations.
- `USER_DISABLED_FEATURES`: **_empty_** Disabled features for users, could be `deletion` and more features can be added in future.
- `USER_DISABLED_FEATURES`: **_empty_** Disabled features for users, could be `deletion`, `manage_ssh_keys`, `manage_gpg_keys` and more features can be added in future.
- `deletion`: User cannot delete their own account.
- `manage_ssh_keys`: User cannot configure ssh keys.
- `manage_gpg_keys`: User cannot configure gpg keys.
- `EXTERNAL_USER_DISABLE_FEATURES`: **_empty_**: Comma separated list of disabled features ONLY if the user has an external login type (eg. LDAP, Oauth, etc.), could be `deletion`, `manage_ssh_keys`, `manage_gpg_keys`. This setting is independent from `USER_DISABLED_FEATURES` and supplements its behavior.
- `deletion`: User cannot delete their own account.
- `manage_ssh_keys`: User cannot configure ssh keys.
- `manage_gpg_keys`: User cannot configure gpg keys.
- `SEND_NOTIFICATION_EMAIL_ON_NEW_USER`: **false**: enable email notifications to instance admins on new user sign-up. It requires `ENABLE_NOTIFY_MAIL` to be true.
## Security (`security`)
@ -518,7 +527,7 @@ And the following unique queues:
- `INSTALL_LOCK`: **false**: Controls access to the installation page. When set to "true", the installation page is not accessible.
- `SECRET_KEY`: **\<random at every install\>**: Global secret key. This key is VERY IMPORTANT, if you lost it, the data encrypted by it (like 2FA secret) can't be decrypted anymore.
- `SECRET_KEY_URI`: **\<empty\>**: Instead of defining SECRET_KEY, this option can be used to use the key stored in a file (example value: `file:/etc/forgejo/secret_key`). It shouldn't be lost like SECRET_KEY.
- `LOGIN_REMEMBER_DAYS`: **7**: Cookie lifetime, in days.
- `LOGIN_REMEMBER_DAYS`: **31**: Cookie lifetime, in days.
- `COOKIE_REMEMBER_NAME`: **gitea_incredible**: Name of cookie used to store authentication
information.
- `REVERSE_PROXY_AUTHENTICATION_USER`: **X-WEBAUTH-USER**: Header name for reverse proxy
@ -580,7 +589,7 @@ And the following unique queues:
## OpenID (`openid`)
- `ENABLE_OPENID_SIGNIN`: **false**: Allow authentication in via OpenID.
- `ENABLE_OPENID_SIGNIN`: **true**: Allow authentication in via OpenID.
- `ENABLE_OPENID_SIGNUP`: **! DISABLE_REGISTRATION**: Allow registering via OpenID.
- `WHITELISTED_URIS`: **\<empty\>**: If non-empty, list of POSIX regex patterns matching
OpenID URI's to permit.
@ -816,8 +825,8 @@ Default templates for project boards:
## Issue and pull request attachments (`attachment`)
- `ENABLED`: **true**: Whether issue and pull request attachments are enabled.
- `ALLOWED_TYPES`: **.csv,.docx,.fodg,.fodp,.fods,.fodt,.gif,.gz,.jpeg,.jpg,.log,.md,.mov,.mp4,.odf,.odg,.odp,.ods,.odt,.patch,.pdf,.png,.pptx,.svg,.tgz,.txt,.webm,.xls,.xlsx,.zip**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
- `MAX_SIZE`: **4**: Maximum size (MB).
- `ALLOWED_TYPES`: **.cpuprofile,.csv,.dmp,.docx,.fodg,.fodp,.fods,.fodt,.gif,.gz,.jpeg,.jpg,.json,.jsonc,.log,.md,.mov,.mp4,.odf,.odg,.odp,.ods,.odt,.patch,.pdf,.png,.pptx,.svg,.tgz,.txt,.webm,.xls,.xlsx,.zip**: Comma-separated list of allowed file extensions (`.zip`), mime types (`text/plain`) or wildcard type (`image/*`, `audio/*`, `video/*`). Empty value or `*/*` allows all types.
- `MAX_SIZE`: **2048**: Maximum size (MB).
- `MAX_FILES`: **5**: Maximum number of attachments that can be uploaded at once.
Additional settings can be included in this section to specify where the data is stored, as [explained in detail in the storage documentation](../storage/).
@ -843,7 +852,7 @@ Additional settings can be included in this section to specify where the data is
- `ResponseWriter`: the responseWriter from the request.
- `RequestID`: the value matching REQUEST_ID_HEADERSdefault: `-`, if not matched.
- You must be very careful to ensure that this template does not throw errors or panics as this template runs outside the panic/recovery script.
- `REQUEST_ID_HEADERS`: **\<empty\>**: You can configure multiple values that are splited by comma here. It will match in the order of configuration, and the first match will be finally printed in the access log.
- `REQUEST_ID_HEADERS`: **\<empty\>**: You can configure multiple values that are split by comma here. It will match in the order of configuration, and the first match will be finally printed in the access log.
- e.g.
- In the Request Header: X-Request-ID: **test-id-123**
- Configuration in app.ini: REQUEST_ID_HEADERS = X-Request-ID
@ -1158,7 +1167,7 @@ ALLOW_DATA_URI_IMAGES = true
- `ELEMENT`: The element this policy applies to. Must be non-empty.
- `ALLOW_ATTR`: The attribute this policy allows. Must be non-empty.
- `REGEXP`: A regex to match the contents of the attribute against. Must be present but may be empty for unconditional whitelisting of this attribute.
- `REGEXP`: A regex to match the contents of the attribute against. Must be present but may be empty for unconditional allowlisting of this attribute.
- `ALLOW_DATA_URI_IMAGES`: **false** Allow data uri images (`<img src="data:image/png;base64,..."/>`).
Multiple sanitisation rules can be defined by adding unique subsections, e.g. `[markup.sanitizer.TeX-2]`.
@ -1177,14 +1186,6 @@ If the rule is defined above the renderer ini section or the name does not match
- `DEFAULT_UI_LOCATION`: Default location of time on the UI, so that we can display correct user's time on UI. i.e. Asia/Shanghai
## Task (`task`)
Task queue configuration has been moved to `queue.task`. However, the below configuration values are kept for backwards compatibility:
- `QUEUE_TYPE`: **channel**: Task queue type, could be `channel` or `redis`.
- `QUEUE_LENGTH`: **1000**: Task queue length, available only when `QUEUE_TYPE` is `channel`.
- `QUEUE_CONN_STR`: **redis://127.0.0.1:6379/0**: Task queue connection string, available only when `QUEUE_TYPE` is `redis`. If redis needs a password, use `redis://123@127.0.0.1:6379/0` or `redis+cluster://123@127.0.0.1:6379/0`.
## Migrations (`migrations`)
- `MAX_ATTEMPTS`: **3**: Max attempts per http/https request on migrations.
@ -1302,11 +1303,12 @@ PROXY_HOSTS = *.github.com
- `ZOMBIE_TASK_TIMEOUT`: **10m**: Timeout to stop the task which have running status, but haven't been updated for a long time.
- `ENDLESS_TASK_TIMEOUT`: **3h**: Timeout to stop the tasks which have running status and continuous updates, but don't end for a long time.
- `ABANDONED_JOB_TIMEOUT`: **24h**: Timeout to cancel the jobs which have waiting status, but haven't been picked by a runner for a long time.
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: Strings committers can place inside a commit message to skip executing the corresponding actions workflow
- `SKIP_WORKFLOW_STRINGS`: **[skip ci],[ci skip],[no ci],[skip actions],[actions skip]**: Strings committers can place inside a commit message or pull request title to skip executing the corresponding actions workflow
## Other (`other`)
- `SHOW_FOOTER_VERSION`: **true**: Show Forgejo and Go version information in the footer.
- `SHOW_FOOTER_TEMPLATE_LOAD_TIME`: **true**: Show time of template execution in the footer.
- `SHOW_FOOTER_POWERED_BY`: **true**: Show the "powered by" text in the footer.
- `ENABLE_SITEMAP`: **true**: Generate sitemap.
- `ENABLE_FEED`: **true**: Enable/Disable RSS/Atom feed.

View file

@ -1,7 +1,7 @@
---
title: 'Database Preparation'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/installation/database-preparation.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/installation/database-preparation.en-us.md'
---
You need a database to use Forgejo. Forgejo supports PostgreSQL (>=12), MySQL (>=8.0) or MariaDB (>=10.0), and SQLite (builtin). This page will guide into preparing the database. Only PostgreSQL and MySQL/MariaDB will be covered here since those database engines are widely-used in production. If you plan to use SQLite, you can ignore this chapter.

View file

@ -1,7 +1,7 @@
---
title: 'Email setup'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/email-setup.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/email-setup.en-us.md'
---
Forgejo can be set to send emails such as a registration confirmation, either with [Sendmail](https://man7.org/linux/man-pages/man8/sendmail.8.html) (or compatible MTAs like Postfix and msmtp) or by connecting to an SMTP server.

View file

@ -1,7 +1,7 @@
---
title: 'Incoming Email'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/incoming-email.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/incoming-email.en-us.md'
---
Forgejo supports the execution of several actions through incoming mails. This page describes how to set this up.

View file

@ -4,7 +4,7 @@ license: 'CC-BY-SA-4.0'
origin_url: 'https://github.com/DanielGibson/DanielGibson.github.io/blob/58362695f743a545d2530508ce42d5fe1eea84a9/content/post/setup-vps-with-wireguard-and-forgejo.md'
---
## Install Forgejo and git, create git user
## Install Forgejo and Git, create git user
> **NOTE:** this guide assumes that you'll host on the server with the domain git.example.com.
@ -22,17 +22,17 @@ and make it executable:
Make sure `git` and `git-lfs` are installed:
`# apt install git git-lfs`
Create a user `git` on the system. Forgejo will run as that user, and when accessing git through ssh
Create a user `git` on the system. Forgejo will run as that user, and when accessing git through SSH
(which is the default), this user is part of the URL _(for example in
`git clone git@git.example.com:YourOrg/YourRepo.git` the `git` before the `@` is the user you'll create now)._
On **Debian, Ubuntu** and their derivates that's done with:
On **Debian, Ubuntu** and their derivatives that's done with:
```
# adduser --system --shell /bin/bash --gecos 'Git Version Control' \
--group --disabled-password --home /home/git git
```
On **Linux distributions not based on Debian/Ubuntu** (this should at least work with Red Hat derivates
On **Linux distributions not based on Debian/Ubuntu** (this should at least work with Red Hat derivatives
like Fedora, CentOS etc.), run this instead:
```
@ -51,7 +51,7 @@ Now create the directories Forgejo will use and set access rights appropriately:
# chown git:git /var/lib/forgejo && chmod 750 /var/lib/forgejo
```
This is the directory Forgejo will store its data in, including your git repos.
This is the directory Forgejo will store its data in, including your Git repositories.
```
# mkdir /etc/forgejo
@ -64,12 +64,12 @@ then it shouldn't modify it anymore.
## Optional: Set up database
When using sqlite as Forgejos database, nothing needs to be done here.
When using sqlite as Forgejo's database, nothing needs to be done here.
If you need a more powerful database, you can use MySQL/MariaDB or PostgreSQL (apparently sqlite
is good enough for at least 10 users, but might even suffice for more).
See [Forgejos Database Preparation guide](../database-preparation/) for
See [Forgejo's Database Preparation guide](../database-preparation/) for
setup instructions.
## Install systemd service for Forgejo
@ -87,7 +87,7 @@ Now enable and start the Forgejo service, so you can go on with the installation
`# systemctl enable forgejo.service`
`# systemctl start forgejo.service`
## Forgejos web-based configuration
## Forgejo's web-based configuration
You should now be able to access Forgejo in your local web browser, so open http://git.example.com:3000/.
@ -116,7 +116,7 @@ Once you're done configuring, click `Install Forgejo` and a few seconds later yo
on the dashboard (if you created an administrator account) or at the login/register screen, where you
can create an account to then get to the dashboard.
So far, so good, but we're not quite done yet - some manual configuration in the app.ini is needed.
So far, so good, but we're not quite done yet - some manual configuration in the `app.ini` is needed.
## Further configuration in Forgejo's app.ini
@ -136,7 +136,7 @@ Now (as root) edit `/etc/forgejo/app.ini`
The following changes are recommended if dealing with many large files:
- Forgejo allows uploading files to git repos through the web interface.
- Forgejo allows uploading files to Git repositories through the web interface.
By default the **file size for uploads**
is limited to 3MB per file, and 5 files at once. To increase it, under the `[repository]` section,
add a `[repository.upload]` section with a line like `FILE_MAX_SIZE = 4095`

View file

@ -6,12 +6,12 @@ license: 'CC-BY-SA-4.0'
Forgejo provides [container images](https://codeberg.org/forgejo/-/packages/container/forgejo/versions) for use with Docker or other containerization tools.
```shell
docker pull codeberg.org/forgejo/forgejo:7.0.0
docker pull codeberg.org/forgejo/forgejo:7.0.3
```
If `codeberg.org` can not be accessed you can replace every mention of `codeberg.org` with `code.forgejo.org` to use our mirror.
The **7** tag is set to be the latest minor release, starting with **7.0.0**. The **7** tag will then be equal to **7.0.0** when it is released and so on.
The **7** tag is set to be the latest minor release, starting with **7.0.x**. The **7** tag will then be equal to **7.0.4** when it is released and so on. The **7.0** tag is also set to be the latest patch version release.
Upgrading from **X** to **X+1** (for instance from **7** to **8**) requires a [manual operation and human verification](../upgrade/). However it is possible to use the **X** tag (for instance **7**) to get the latest minor release automatically.
@ -67,89 +67,7 @@ ENABLE_PUSH_CREATE_USER = true
> **NOTE:** it is not possible to use environment variables to remove an existing value, it must be done by editing the `app.ini` file.
> **NOTE:** in case you are in a selinux environment check the audit logs if you are having issues with containers.
## Rootless
Forgejo also supports a rootless Docker image.
With this image, the Docker container can run as an unprivileged user, which means that an attacker will not have root privileges on the server even when they gain access to the container.
This configuration is slightly more involved because we need to prepare our data folders.
To do so, we create a `data` folder with permissions for the user with `UID` and `GID` 1000.
This is the user which should **not** have root privileges.
```sh
#!/usr/bin/env bash
set -e
mkdir -p work
mkdir -p work/data
chown -R 1000:1000 work/data
chmod 775 work/data
chmod g+s work/data
```
```yaml
version: '3'
networks:
forgejo:
external: false
services:
gitea:
image: 'codeberg.org/forgejo/forgejo:1.21-rootless'
container_name: 'forgejo'
environment:
USER_UID: '1000'
USER_GID: '1000'
FORGEJO_WORK_DIR: '/var/lib/forge'
user: '1000:1000'
networks:
- forgejo
ports:
- '3000:3000'
- '222:22'
volumes:
- ./forgejo:/data:rw'
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro
# Right side of this mount depends on the `FORGEJO_WORK_DIR` var above.
- ./work:/var/lib/forge:rw
logging:
driver: 'json-file'
options:
max-size: '10m'
max-file: '10'
restart: 'unless-stopped'
```
To also mount a locally defined `app.ini`, add
```yaml
- ./app.ini:/etc/gitea/app.ini
```
to `volumes`.
Next, run this with
```sh
docker compose up
```
To, for example, add an admin user from the command line, use:
```sh
docker exec -ti forgejo /bin/bash
```
and
```sh
forgejo admin user create --username <USERNAME> --password <PASSWORD> --email <EMAIL> --admin
```
> **NOTE:** in case you are in a SELinux environment check the audit logs if you are having issues with containers.
## Databases
@ -266,7 +184,7 @@ An important assumption for the Forgejo image to make is to own the folders it w
and reads from. This is naturally an issue since file-system permissions are a machine-local
concept and don't translate over the network easily.
We assume that a server with the hostname `server` is accessible which has a folder `/respositories`
We assume that a server with the hostname `server` is accessible which has a folder `/repositories`
shared via NFS. Append an entry to your `/etc/exports` like
```shell
@ -286,7 +204,7 @@ Four aspects to consider:
Effectively we are now able to write and create files and folders on the remote share. With the `all_squash` setting, we map
all users to one user, hence all data writable by one user is writable by all users, implying all files have a `drwxrwxrwx`
setting (abreviated "`0777` permissions"). We can also "fake-own" data, since all `chown` calls are now mapped to the anonymous user. This is an
setting (abbreviated "`0777` permissions"). We can also "fake-own" data, since all `chown` calls are now mapped to the anonymous user. This is an
important behaviour.
We now mount this folder on the `client` which will host Forgejo to a folder `/mnt/repositories`...
@ -330,7 +248,7 @@ services:
- forgejo
volumes:
- - ./forgejo:/data
+ - /mnt/repositories/data:/data
+ - /mnt/repositories/data:/var/lib/gitea
+ - /mnt/repositories/conf:/etc/gitea
- /etc/timezone:/etc/timezone:ro
- /etc/localtime:/etc/localtime:ro

View file

@ -3,10 +3,13 @@ title: 'Installation'
license: 'CC-BY-SA-4.0'
---
Forgejo publishes a stable release every three months and a long term
support (LTS) release every year. Patch releases are published more
frequently and provide fixes for bugs and security
vulnerabilities. See also how [the Forgejo versioning scheme](../../user/versions) works.
Forgejo publishes a stable release every three months and a long term support
(LTS) release every year. Patch releases are published more frequently and
provide fixes for bugs and security vulnerabilities. Please review the
[releases management](../../developer/release) and
also the
[Forgejo versioning scheme](../../user/versions) documentation for further
information.
This guide covers the installation of Forgejo [with
Docker](../installation-docker/) or [from
@ -14,9 +17,9 @@ binary](../installation-binary/). Both of these methods are created
and extensively tested to work on every release. They consist of three
steps:
- Download and run the release
- Connect to the web interface and complete the configuration
- And finally register the first user which will be granted administrative permissions
- Download and run the release,
- connect to the web interface and complete the configuration, and,
- finally register the first user which will be granted administrative permissions.
If you already have Gitea installed through your package manager, look at the [Gitea
migration](../gitea-migration/) guide for information on how to install Forgejo, while

View file

@ -1,7 +1,7 @@
---
title: 'Logging Configuration'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/logging-config.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/logging-config.en-us.md'
---
The logging configuration of Forgejo mainly consists of 3 types of components:

View file

@ -7,7 +7,7 @@ Moderation tools are meant to help the Forgejo users and admins cope
with spam bots and undesirable interactions.
`[admin].SEND_NOTIFICATION_EMAIL_ON_NEW_USER` can be set to `true` on
small Fogejo instances with an open registration. Such instances are
small Forgejo instances with an open registration. Such instances are
subject to occasional spam bots registrations and saves the admin the
trouble to check on a regular basis. Read more in the [config cheat
sheet](../config-cheat-sheet/#security-security).

View file

@ -3,13 +3,9 @@ title: 'OAuth2 provider'
license: 'CC-BY-SA-4.0'
---
Forgejo can act as an instance wide OAuth2 provider. To achieve that, OAuth2 applications must be created in the `/admin/applications` page.
> **NOTE:** Third party applications obtaining a token for a user via such an application will have administrative rights. OAuth2 scopes are not yet implemented.
## Pre-registered applications
The following OAuth2 applications are pre-registered beause it is generally useful for Forgejo to be an OAuth2 provider for the corresponding third party software. Their usage is explained in the [Forgejo user guide](../../user/oauth2-provider/).
The following OAuth2 applications are pre-registered because it is generally useful for Forgejo to be an OAuth2 provider for the corresponding third party software. Their usage is explained in the [Forgejo user guide](../../user/oauth2-provider/).
- **git-credential-manager** is the name of the OAuth2 application for the [Git Credential Manager](https://github.com/git-ecosystem/git-credential-manager) (a Git [credential helper](https://git-scm.com/docs/gitcredentials#_custom_helpers))
- **git-credential-oauth** is the name of the OAuth2 application for the [git-credential-oauth](https://github.com/hickford/git-credential-oauth) (a Git [credential helper](https://git-scm.com/docs/gitcredentials#_custom_helpers))

View file

@ -78,4 +78,4 @@ AcceptEnv GIT_PROTOCOL
### Database performance
When trying to undertand poor database performance in conjunction with Forgejo, it is useful to set `[database].SLOW_QUERY_THRESHOLD` to a value lower than the default (5 seconds). This ensures that SQL queries that are slow, but not too slow to meet the default value, are logged and can provide insight into what kind of SQL queries are slow, moreover, this is useful information for Forgejo contributors to find the code where this SQL query is executed and understand the context.
When trying to understand poor database performance in conjunction with Forgejo, it is useful to set `[database].SLOW_QUERY_THRESHOLD` to a value lower than the default (5 seconds). This ensures that SQL queries that are slow, but not too slow to meet the default value, are logged and can provide insight into what kind of SQL queries are slow, moreover, this is useful information for Forgejo contributors to find the code where this SQL query is executed and understand the context.

View file

@ -1,9 +1,233 @@
---
title: 'Reverse proxy'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/authentication.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/authentication.en-us.md'
---
Forgejo serve itself without a reverse proxy with HTTP and HTTPS.
HTTP transport is used by default, to turn on HTTPS transport set in `SERVER` section of the configuration `PROTOCOL=https` and either set `CERT_FILE` and `KEY_FILE` or let Forgejo manage the certificates with `ENABLE_ACME=true`
You may wish to place your Forgejo instance behind a reverse proxy. A reverse proxy is a server that accepts requests from the outside and routes them to internal services, like Forgejo.
## nginx
### Basic HTTP
To set up a basic HTTP reverse proxy in nginx, create a file `forgejo.conf` in `/etc/nginx/conf.d` and add the following configuration:
```nginx
server {
listen 80; # Listen on IPv4 port 80
listen [::]:80; # Listen on IPv6 port 80
server_name git.example.com; # Change this to the server domain name.
location / {
proxy_pass http://127.0.0.1:3000; # Port 3000 is the default Forgejo port
proxy_set_header Connection $http_connection;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
client_max_body_size 512M;
}
}
```
Make sure to reload/restart nginx after changing the configuration.
### HTTP with a subpath
If you want to serve Forgejo on a subpath, e.g. on `http://example.com/forgejo`, use the following configuration:
```nginx
server {
listen 80; # Listen on IPv4 port 80
listen [::]:80; # Listen on IPv6 port 80
server_name example.com; # Change this to the server domain name.
location /forgejo/ { # Replace forgejo here with your subpath
rewrite ^ $request_uri;
rewrite ^/forgejo(/.*) $1 break;
return 400;
proxy_pass http://127.0.0.1:3000$uri;
proxy_set_header Connection $http_connection;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
client_max_body_size 512M;
}
}
```
Make sure to set the Forgejo `ROOT_URL` configuration key to the URL _with_ the subpath, otherwise links generated by Forgejo will be broken.
### HTTPS
When using a reverse proxy, it's usually easier to let the proxy handle HTTPS. It's easy to set up HTTPS on nginx.
#### HTTPS with Certbot
To set up HTTPS with Certbot, first set up an HTTP reverse proxy with the configuration above and ensure that it works as expected. To use HTTPS you need to have a domain name.
Then, install [certbot](https://certbot.eff.org/). When running certbot, select the domain name that your Forgejo instance is hosted under, and choose automatic installation. This should automatically set up HTTPS on port 443 and a redirect on the old port 80.
You may wish to change the `ROOT_URL` configuration key to the HTTPS protocol so links generated by Forgejo automatically use HTTPS.
#### HTTPS with manually installed certificates
If you have obtained certificates from elsewhere or have chosen not to let certbot automatically install them, make the following changes to the configuration file:
**Change the listening ports**
Change the lines
```nginx
listen 80;
listen [::]:80;
```
to
```nginx
listen 443 ssl http2;
listen [::]:443 ssl http2;
```
**Add the SSL certificate information**
Generate an SSL configuration at [mozilla](https://ssl-config.mozilla.org/#server=nginx), and add the SSL parameters to your configuration file. Make sure to replace the paths in the example with paths to your certificate files.
**Add a redirect from HTTP**
Outside the server block, add this redirection block:
```nginx
server {
listen 80 default_server;
listen [::]:80 default_server;
location / {
return 301 https://$host$request_uri;
}
}
```
This will redirect anyone visiting the HTTP site to the HTTPS site.
## Apache
### Basic HTTP
To set up a basic HTTP proxy in Apache, create a file `100-forgejo.conf` in `/etc/apache2/sites-available` and add the following configuration:
```apache
<VirtualHost *:80>
ServerName git.example.com
ProxyPreserveHost On
ProxyRequests off
AllowEncodedSlashes NoDecode
ProxyPass / http://127.0.0.1:3000/ nocanon
</VirtualHost>
```
Next, enable the site with `a2ensite 100-forgejo.conf` and enable the proxy modules with `a2enmod proxy proxy_http`. Finally, restart the apache server.
### HTTP with a subpath
If you want to serve Forgejo on a subpath, e.g. on `http://example.com/forgejo`, use the following configuration:
```apache
<VirtualHost *:80>
ServerName example.com
ProxyPreserveHost On
ProxyRequests off
AllowEncodedSlashes NoDecode
ProxyPass /forgejo http://127.0.0.1:3000/ nocanon # Change /forgejo here to your desired subpath.
</VirtualHost>
```
Make sure to set the Forgejo `ROOT_URL` configuration key to the URL _with_ the subpath, otherwise links generated by Forgejo will be broken.
### HTTPS
When using a reverse proxy, it's usually easier to let the proxy handle HTTPS. It's easy to set up HTTPS on apache.
#### HTTPS with Certbot
To set up HTTPS with Certbot, first set up an HTTP reverse proxy with the configuration above and ensure that it works as expected. To use HTTPS you need to have a domain name.
Then, install [certbot](https://certbot.eff.org/). When running certbot, select the domain name that your Forgejo instance is hosted under, and choose automatic installation. This should automatically set up HTTPS on port 443 and a redirect on the old port 80.
You may wish to change the `ROOT_URL` configuration key to the HTTPS protocol so links generated by Forgejo automatically use HTTPS.
#### HTTPS with manually installed certificates
If you have obtained certificates from elsewhere or have chosen not to let certbot automatically install them, make the following changes to the configuration file:
**Change the listening ports**
Change `<VirtualHost *:80>` to `<VirtualHost *:443>`.
**Add the SSL certificate information**
Generate an SSL configuration at [mozilla](https://ssl-config.mozilla.org/#server=apache), and add the SSL parameters to your configuration file. Make sure to replace the paths in the example with paths to your certificate files.
**Add a redirect from HTTP**
Outside the `VirtualHost *:443`, add this configuration:
```apache
<VirtualHost *:80>
ServerName git.example.com
RewriteEngine on
RewriteCond %{SERVER_NAME} =git.example.com
RewriteRule ^ https://%{SERVER_NAME}%{REQUEST_URI} [END,NE,R=permanent]
</VirtualHost>
```
This will redirect anyone visiting the HTTP site to the HTTPS site.
## Caddy
### HTTPS
To set up basic HTTPS proxy in Caddy with Caddyfile create a file `forgejo` in `/etc/caddy/conf.d` and add the following configuration:
```Caddyfile
git.example.com {
reverse_proxy 127.0.0.1:3000
}
```
Caddy will automatically get certificates for the domain.
### HTTPS with a subpath
If you want to serve Forgejo on a subpath, e.g. on https://example.com/forgejo, use the following configuration:
```Caddyfile
example.com {
reverse_proxy /forgejo* 127.0.0.1:3000
}
```
Make sure to set the Forgejo ROOT_URL configuration key to the URL with the subpath, otherwise links generated by Forgejo will be broken.
## Proxy Authentication
Forgejo supports Reverse Proxy Header authentication, it will read headers as a trusted login user name or user email address. This hasn't been enabled by default, you can enable it with
```ini
@ -24,5 +248,5 @@ Notice: Reverse Proxy Auth doesn't support the API. You still need an access tok
## Docker / Container Registry
The container registry uses a fixed sub-path `/v2` which can't be changed.
Even if you deploy Gitea with a different sub-path, `/v2` will be used by the `docker` client.
Even if you deploy Forgejo with a different sub-path, `/v2` will be used by the `docker` client.
Therefore you may need to add an additional route to your reverse proxy configuration.

View file

@ -1,7 +1,7 @@
---
title: 'Search Engines Indexation'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/search-engines-indexation.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/search-engines-indexation.en-us.md'
---
## Search engines indexation of your Forgejo installation

View file

@ -1,7 +1,7 @@
---
title: 'Seek Assistance'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/help/seek-help.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/help/support.en-us.md'
---
- [Chatroom](https://matrix.to/#/#forgejo-chat:matrix.org)
@ -36,7 +36,7 @@ origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb7
3. Any error messages you are seeing.
4. If you meet slow/hanging/deadlock problems, please report the stack trace when the problem occurs:
1. Enable pprof in `app.ini` and restart Forgejo
1. Enable pprof in `app.ini` and restart Forgejo.
```ini
[server]
@ -45,4 +45,4 @@ origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb7
2. Trigger the bug, when Forgejo gets stuck, use curl or browser to visit: `http://127.0.0.1:6060/debug/pprof/goroutine?debug=1` (IP must be `127.0.0.1` and port must be `6060`).
3. If you are using Docker, please use `docker exec -it <container-name> curl "http://127.0.0.1:6060/debug/pprof/goroutine?debug=1"`.
4. Report the output (the stack trace doesn't contain sensitive data)
4. Report the output (the stack trace doesn't contain sensitive data).

View file

@ -1,7 +1,7 @@
---
title: 'GPG Commit Signatures'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/signing.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/signing.en-us.md'
---
Forgejo will verify GPG commit signatures in the provided tree by
@ -54,7 +54,7 @@ There are three main options:
- `none` - this prevents Forgejo from signing any commits
- `default` - Forgejo will default to the key configured within `git config`
- `KEYID` - Forgejo will sign commits with the gpg key with the ID
- `KEYID` - Forgejo will sign commits with the GPG key with the ID
`KEYID`. In this case you should provide a `SIGNING_NAME` and
`SIGNING_EMAIL` to be displayed for this key.
@ -120,7 +120,7 @@ The possible options are:
- `never`: Never sign
- `pubkey`: Only sign if the user has a public key
- `twofa`: Only sign if the user logs in with two-factor authentication
- `basesigned`: Only sign if the parent commit in the base repo is signed.
- `basesigned`: Only sign if the parent commit in the base repository is signed.
- `headsigned`: Only sign if the head commit in the head branch is signed.
- `commitssigned`: Only sign if all the commits in the head branch to the merge point are signed.
- `approved`: Only sign approved merges to a protected branch.

View file

@ -84,6 +84,22 @@ the `forgejo` bucket, LFS to `lfs/` in the `forgejo` bucket etc.
> **NOTE:** `MINIO_BASE_PATH` must not be set in the `[storage]` section.
The configuration option `MINIO_USE_SSL` defaults to `false` to maintain compatibility with locally hosted MinIO instances. If an external S3 provider is intended to be used, this option should be set to `true`.
For instance, assuming a MinIO instance at `https://minio.example.com`:
```
[storage]
STORAGE_TYPE = minio
MINIO_USE_SSL = true
MINIO_ENDPOINT = minio.example.com
MINIO_ACCESS_KEY_ID = [redacted]
MINIO_SECRET_ACCESS_KEY = [redacted]
MINIO_BUCKET = bucket
MINIO_LOCATION = us-east-1
```
## Storage settings for a single subsystem
It is possible to configure some subsystems to use S3 storage and others to use local
@ -166,6 +182,7 @@ connect to a S3 compatible server:
- `MINIO_LOCATION`: **us-east-1**: S3 location to create bucket.
- `MINIO_USE_SSL`: **false**: S3 enabled ssl.
- `MINIO_INSECURE_SKIP_VERIFY`: **false**: S3 skip SSL verification.
- `MINIO_CHECKSUM_ALGORITHM`: Minio checksum algorithm: **default** (for MinIO, garage or AWS S3) or **md5** (for Cloudflare or Backblaze)
When used in the `[storage]` section they apply to all
subsystems. When used in the section specific to a subsystem (see the table in the introduction), they
@ -184,6 +201,7 @@ MINIO_BUCKET_LOOKUP = auto
MINIO_LOCATION = us-east-1
MINIO_USE_SSL = false
MINIO_INSECURE_SKIP_VERIFY = false
MINIO_CHECKSUM_ALGORITHM = md5
[lfs]
STORAGE_TYPE = minio
@ -218,7 +236,7 @@ within the `forgejo` bucket instead of the `lfs/` directory
Although the S3 storage type is named `minio` it does not rely on any
[MinIO](https://min.io/) specific features. The S3 storage type is
[tested](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/.forgejo/upgrades/test-upgrade.sh) to be compatible with:
[tested](https://code.forgejo.org/forgejo/end-to-end/src/commit/9cfd043b8af18ce0df48fa6e44772d9bd521cab4/storage/storage.sh) to be compatible with:
- [MinIO](https://min.io/) 2021.3.17 and 2023-08-23
- [garage](https://garagehq.deuxfleurs.fr/) v0.8.2

View file

@ -17,7 +17,7 @@ To be notified in advance of security releases, watch or subscribe to the RSS fe
## Semantic version compliance
Forgejo is compliant with [semantic versioning](https://semver.org/spec/v2.0.0.html) as of 7.0.0. In a nutshell it means that there is no breaking change unless the first number changes (e.g. when 8.0.0 is published it will contain breaking changes compared to 7.0.0). The release notes document those breaking changes and theey may require manual intervention depending on the Forgejo installation.
Forgejo is compliant with [semantic versioning](https://semver.org/spec/v2.0.0.html) as of 7.0.0. In a nutshell it means that there is no breaking change unless the first number changes (e.g. when 8.0.0 is published it will contain breaking changes compared to 7.0.0). The release notes document those breaking changes and they may require manual intervention depending on the Forgejo installation.
In versions prior to 7.0.0, the releases 1.19, 1.20 and 1.21 all contained breaking changes and the versioning scheme was not compliant with semantic versioning.
@ -48,7 +48,7 @@ It is **critical** to verify that Forgejo works very carefully. Restoring the ba
- Manually analyze (reading the patches to the sources of the template directory) and update the customized CSS / content.
- Do not use `forgejo help` to figure out the location of `CustomPath`, look at the configuration tab of the `Site administration` panel when logged in as an admin.
- `forgejo manager flush-queues`. If it timesout, run it again with a more generous `--timeout` argument. It is important because the queues contain serialized data that is not guaranteed to be backward compatible between versions.
- `forgejo manager flush-queues`. If it times out, run it again with a more generous `--timeout` argument. It is important because the queues contain serialized data that is not guaranteed to be backward compatible between versions.
- Go to the `Site administration` panel and pause all queues
Note: Forgejo requires [docker >= 20.10.6](https://wiki.alpinelinux.org/wiki/Release_Notes_for_Alpine_3.14.0) otherwise mysterious problems will happen (mysterious in the sense that the problem will about something unrelated to the Docker version").
@ -95,10 +95,16 @@ The database version is stored in the database and used to prevent an accidental
- Any version before [Gitea 1.17](https://github.com/go-gitea/gitea/releases/tag/v1.17.4)
- preserve a custom gitconfig: [episode 1](https://web.archive.org/web/20240313092747/https://gna.org/blog/1-17-breaking-episode-1/), [episode 2](https://web.archive.org/web/20240313092759/https://gna.org/blog/1-17-breaking-episode-2/)
- [Gitea 1.13.0](https://blog.gitea.io/2020/12/gitea-1.13.0-is-released/)
- The Webhook shared secret inside the webhook payload has been deprecated and will be removed in 1.14.0: https://github.com/go-gitea/gitea/issues/11755 please use the secret header that uses an hmac signature to validate the webhook payload.
- Git hooks now default to `off`! ([#13058](https://github.com/go-gitea/gitea/pull/13058))
In your config, you can check the security section for `DISABLE_GIT_HOOKS`. To enable them again, you must set the setting to `false`.
- From an instance originally installed with gogs, even if migrated later to Gitea or Forgejo because database columns are not automatically removed by migrations.
- Drop the `created` column from the `issue` table while Forgejo is not running. It will be re-created:
- SQLite `ALTER TABLE `issue`DROP`created``
- MySQL/MariaDB/PostgreSQL `ALTER TABLE `issue`DROP COLUMN`created``
### Only when upgrading to a specific version
- From [v1.19] to a version greater or equal to than [1.20](https://forgejo.org/2023-07-release-v1/)
@ -122,7 +128,7 @@ The database version is stored in the database and used to prevent an accidental
- Gogs from before September 2015 migrated to Forgejo v1.18 may have a [dangling `pull_repo` table](https://web.archive.org/web/20230207122019/https://forum.gna.org/t/gitea-upgrade-from-gogs-to-1-16-8-unmigrated-pull-repo-table/73) and the corresponding pull requests will be removed by `gitea doctor check --fix --all`.
[From the 1.11.3 release notes](https://blog.gitea.io/2020/03/gitea-1.11.3-and-1.10.6-released/):
[From the 1.11.3 release notes](https://blog.gitea.com/release-of-1.11.3/):
- v1.10.0, v1.10.1, v1.10.2, v1.10.3, v1.10.4, v1.11.0, and v1.11.1 **do not use** any of these versions, as a bug in the upgrade process will delete attachments from the releases on your repositories.
- v1.11.2 (now replaced by 1.11.3) was mistakenly compiled with Go 1.14, which Gitea is not currently fully tested with and its known to cause [a few issues](https://github.com/go-gitea/gitea/issues/10661).

View file

@ -9,4 +9,4 @@ The Forgejo [domains](https://codeberg.org/forgejo/meta/issues/41) are owned by
## Forgejo Governance
Forgejo was bootstraped in November 2022 and defines [its governance](https://codeberg.org/forgejo/governance/src/branch/main/README.md) in a [dedicated repository](https://codeberg.org/forgejo/governance).
Forgejo was bootstrapped in November 2022 and defines [its governance](https://codeberg.org/forgejo/governance/src/branch/main/README.md) in a [dedicated repository](https://codeberg.org/forgejo/governance).

View file

@ -7,18 +7,18 @@ license: 'CC-BY-SA-4.0'
Forgejo stable releases are published on a fixed schedule, every quarter.
| **Date** | **Version** | **Release date** | **End Of Life** |
| -------- | ---------------------- | ---------------- | ---------------- |
| 2024 Q1 | 7.0.0+LTS-gitea-1.22.0 | 23 April 2024 | **16 July 2025** |
| 2024 Q2 | X.Y.Z+gitea-A.B.C | 17 July 2024 | 16 October 2024 |
| 2024 Q3 | X.Y.Z+gitea-A.B.C | 16 October 2024 | 15 January 2025 |
| 2024 Q4 | X.Y.Z+gitea-A.B.C | 15 January 2025 | 16 April 2025 |
| 2025 Q1 | X.Y.Z+LTS-gitea-A.B.C | 16 April 2025 | **14 July 2026** |
| 2025 Q2 | X.Y.Z+gitea-A.B.C | 16 July 2025 | 15 October 2025 |
| 2025 Q3 | X.Y.Z+gitea-A.B.C | 15 October 2025 | 14 January 2026 |
| 2025 Q4 | X.Y.Z+gitea-A.B.C | 14 January 2026 | 15 April 2026 |
| 2026 Q1 | X.Y.Z+LTS-gitea-A.B.C | 15 April 2026 | **14 July 2027** |
| 2026 Q2 | X.Y.Z+gitea-A.B.C | 15 July 2026 | 14 October 2026 |
| **Date** | **Version** | **Release date** | **End Of Life** |
| -------- | ------------------------ | ---------------- | ---------------- |
| 2024 Q1 | 7.0.0+gitea-1.22.0 (LTS) | 23 April 2024 | **16 July 2025** |
| 2024 Q2 | 8.0.0+gitea-A.B.C | 17 July 2024 | 16 October 2024 |
| 2024 Q3 | X.Y.Z+gitea-A.B.C | 16 October 2024 | 15 January 2025 |
| 2024 Q4 | X.Y.Z+gitea-A.B.C | 15 January 2025 | 16 April 2025 |
| 2025 Q1 | X.Y.Z+gitea-A.B.C (LTS) | 16 April 2025 | **14 July 2026** |
| 2025 Q2 | X.Y.Z+gitea-A.B.C | 16 July 2025 | 15 October 2025 |
| 2025 Q3 | X.Y.Z+gitea-A.B.C | 15 October 2025 | 14 January 2026 |
| 2025 Q4 | X.Y.Z+gitea-A.B.C | 14 January 2026 | 15 April 2026 |
| 2026 Q1 | X.Y.Z+gitea-A.B.C (LTS) | 15 April 2026 | **14 July 2027** |
| 2026 Q2 | X.Y.Z+gitea-A.B.C | 15 July 2026 | 14 October 2026 |
### Stable release support
@ -42,14 +42,11 @@ The Forgejo release numbers are compliant with [Semantic Versioning](https://sem
- Forgejo **v7.1.0+gitea-1.22.0** is compatible with Gitea **v1.22.0**.
Long term support releases have the `LTS` string in their metadata. For instance:
The release candidates are built of the stable branch and published with the **-test** suffix:
- Forgejo **v7.0.0+LTS-gitea-1.22.0** is a long term support release compatible with Gitea **v1.22.0**.
The release candidates are composed by adding the `-rc` suffix. For instance:
- Forgejo **v7.1.0-rc0+gitea-1.22.0**
- Forgejo **v7.1.0-rc1+gitea-1.22.0**
- Forgejo **v7.0-test**
- Forgejo **v8.0-test**
- Forgejo **v8.1-test**
- etc.
## Stable release process
@ -84,6 +81,11 @@ When a new `vX.Y.Z` release is ready to enter the release candidate stages:
- Add add a `vX.Y/forgejo` branch protection rule https://codeberg.org/forgejo/forgejo/settings/branches
- Trigger a mirror workflow in https://codeberg.org/forgejo/forgejo and verify the `X.Y-test` and `(X+1).0-test` releases are published in https://codeberg.org/forgejo-experimental
- Update end-to-end to [know about the new release](https://code.forgejo.org/forgejo/end-to-end/pulls/139). It must be done after the first `(X+1).0-test` release is available in experimental otherwise it will fail to find it and will block the automated release process in the forgejo-integration repository
- Documentation
- In [the documentation](https://codeberg.org/forgejo/docs)
- Create the `vX.Y` branch from next
- Create the `backport/vX.Y` label
- In [the website](https://codeberg.org/forgejo/website) add a submodule similar to [this commit](https://codeberg.org/forgejo/website/commit/3f1e62be22f96d048309157e8779cbfcf204eb90)
### Release Notes
@ -133,7 +135,7 @@ Reach out to packagers and users to manually verify the release works as expecte
It will trigger a workflow to:
- Push the vX.Y.Z tag to https://codeberg.org/forgejo/forgejo
- Downoad Binaries from https://codeberg.org/forgejo-experimental, sign them and copy them to https://codeberg.org/forgejo
- Download Binaries from https://codeberg.org/forgejo-experimental, sign them and copy them to https://codeberg.org/forgejo
- Copy container images from https://codeberg.org/forgejo-experimental to https://codeberg.org/forgejo
### Forgejo release mirror
@ -150,8 +152,8 @@ The release is built on https://code.forgejo.org/forgejo-integration/runner, whi
The release is published on
https://forgejo.octopuce.forgejo.org/forgejo/runner, which is a mirror
of https://code.forgejo.org/forgejo-integration/runner. It is behind a
VPN and its role is to copy and sign release artifacts.
of https://code.forgejo.org/forgejo-integration/runner. It has no public IP
and its role is to copy and sign release artifacts.
- Binaries are downloaded from https://code.forgejo.org/forgejo-integration/runner, signed and copied to https://code.forgejo.org/forgejo/runner.
- Container images are copied from https://code.forgejo.org/forgejo-integration to https://code.forgejo.org/forgejo
@ -169,7 +171,7 @@ providing the secrets from the command line.
### Securing the release token and cryptographic keys
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo isntance running [behind a VPN](../infrastructure/#octopuce) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
For both the Forgejo runner and Forgejo itself, copying and signing the release artifacts (container images and binaries) happen on a Forgejo instance [not publicly accessible](../infrastructure/#octopuce) to safeguard the token that has write access to the Forgejo repository as well as the cryptographic key used to sign the releases.
### Website update

View file

@ -19,7 +19,7 @@ $ gopass recipients add
```
3. [Install gopass](https://www.gopass.pw/#install)
> :warning: When installing on Ubuntu or Debian you can either download the deb package, install manually or build from source or use our APT repository ([github comment](https://github.com/gopasspw/gopass/issues/1849#issuecomment-802789285) with more information).
> :warning: When installing on Ubuntu or Debian you can either [download the deb package](https://github.com/gopasspw/gopass/tags), install manually or build from source or use our APT repository ([github comment](https://github.com/gopasspw/gopass/issues/1849#issuecomment-802789285) with more information).
4. Clone this repo using `gopass` (the name and email are for `git config`)
```

View file

@ -1,7 +1,7 @@
---
title: 'Interface customization'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/administration/customizing-gitea.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/administration/customizing-gitea.en-us.md'
---
This sections documents the Forgejo interface customization that requires an intimate knowledge of the underlying codebase. The user interface customization documented and supported for Forgejo admins to use [is found in the corresponding administrator guide section](../../admin/customization/).

View file

@ -9,15 +9,87 @@ Forgejo relies on hundreds of Free Software components and they all need to be u
Software referenced by a release (even if such a release is the hash of a commit). They are listed in the [dependency dashboard](https://codeberg.org/forgejo/forgejo/issues/2779) which is updated by [renovate](https://github.com/renovatebot/renovate) from [the renovate.json configuration file](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/renovate.json).
Pull [requests are opened](https://codeberg.org/forgejo/forgejo/pulls?poster=165503) when an upgrade is available and the decision to merge (positive review) or not (request for change review) depends on what the upgrade offers.
## Decision to upgrade
An upgrade is justified if:
- it is beneficial to Forgejo
- the risk of regression is low compared to the benefit
There is no need to upgrade if there is no indication that it is beneficial to Forgejo.
## Reviewing renovate pull requests
Pull [requests are opened](https://codeberg.org/forgejo/forgejo/pulls?poster=165503) when an upgrade is available and the decision to merge (positive review) or not (request for change review) depends on what the upgrade offers. The history of past upgrades can be browsed by looking for PR with the same title (e.g. [happy-dom upgrades](https://codeberg.org/forgejo/forgejo/pulls?q=Update+dependency+happy-dom)).
- The PR contains information about the release. If it does not, it has detailed references that can be used to browse the commits in the dependency source repository and figure out what the changes are.
- The comment of the review:
- explains the decision (needed, not needed)
- explains why the change has an impact on Forgejo
- If the upgrade is needed, user visible changes must be included in the draft release notes for the upcoming release.
- If the upgrade is needed, user visible changes must be included in the draft release notes for the upcoming release. See [this upgrade for an example](https://codeberg.org/forgejo/forgejo/pulls/3724/files).
- Security fix and important bug fixes are backported to the stable releases.
- Set the dependency label
Note that renovate will keep a few (see `prConcurrentLimit` in [renovate.json](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/renovate.json)) pull request open at any given time. If no decision is made, newer upgrades will accumulate in the backlog visible in the [dashboard](https://codeberg.org/forgejo/forgejo/issues/2779).
The [release team](https://codeberg.org/forgejo/governance/src/branch/main/TEAMS.md#releases) looks after the pull requests, to the extent that they can be tested automatically. If manual testing is required (because there is no test coverage for the part of the code that would be impacted by an upgrade), a review will be requested from the people who have the required expertise to either improve the test coverage or come up with a manual test procedure to be repeated.
## Tuning a software upgrade
There is no uniformity in how software is released and they call for different strategies to deal with upgrades:
- **grouping related software**.
When the decision to upgrade applies to a number of related software, it is less noisy to have them all upgraded in a single PR rather than a number of individual PRs. Such dependencies can be grouped together.
- **using a renovate [group preset](https://docs.renovatebot.com/presets-group/):** e.g. `group:linters` include `eslint`, `eslint-plugin-array-func`, `eslint-plugin-github` etc. See also [an example PR](https://codeberg.org/forgejo/forgejo/pulls/3921).
- **creating a new group:**
```json
{
"description": "Group golang packages",
"matchDepNames": [
"go",
"golang",
"docker.io/golang",
"docker.io/library/golang"
],
"groupName": "golang packages"
},
```
- **release on every commit or so**.
There are usually no release notes and there is no notion of release ([monaco-editor](https://github.com/microsoft/monaco-editor/tags)) which may lead to frequent proposals to upgrade. It is similar to software that it tagged with a commit hash instead of a version, either because it does not publish versions ([go-ap](https://github.com/go-ap/activitypub)) or because a particular bug fix is needed before the release is available ([go-rpmutils](github.com/sassoftware/go-rpmutils)).
- control the upgrade frequency with `schedule` (e.g. `schedule:quarterly` for [pprof](https://github.com/google/pprof)).
- impose a delay with `minimumReleaseAge` (e.g. `monaco-editor` upgrades are considered no more frequently than once a month).
- require dashboard approval with `dependencyDashboardApproval` (e.g. `go-ap` upgrades will never be proposed unless manually required from the [dashboard](https://codeberg.org/forgejo/forgejo/issues/2779).
- **automerge CI dependencies**.
The dependencies that are exclusively used in the CI and demonstrated to work as expected when it passes can be merged automatically. They are listed in [renovate.json](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/renovate.json)) in the `Automerge some packages when CI succeeds` stanza as follows.
- **extends:** if the software is included in a known renovate package preset (e.g. ["packages:linters"](https://docs.renovatebot.com/presets-packages/#packageslinters)). Figuring out if that is the case requires looking at the output of a renovate run and analyzing the debug logs.
- **matchDepNames:** to explicitly list the dependency (e.g. `markdownlint-cli`).
- **matchPackagePrefixes:** if a range of CI related dependency happen to share the same prefix (e.g. `@playwright/`)
- **automerge patch releases**.
When a software is known to be good at publishing quality patch releases (in the [semver](https://semver.org/spec/v2.0.0.html) sense), the proposed upgrades can be merged automatically. This can be done in a way similar to `vue` in [renovate.json](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/renovate.json)).
```json
{
"matchDepNames": [
"vue"
],
"separateMinorPatch": true
},
{
"matchDepNames": ["vue"],
"matchUpdateTypes": ["patch"],
"automerge": true
},
```
# Soft forks

View file

@ -29,3 +29,85 @@ Do you know how to configure it properly? Why not document that here?
Vim has [a Go plugin](https://github.com/fatih/vim-go) that can likely be used to work on Forgejo's code base.
Do you know how to configure it properly? Why not document that here?
## Neovim
Here's a minimal example that configures `gopls` and `golangci_lint_ls` using
the `Lazy.nvim` plugin manager.
<details>
<summary>init.lua</summary>
```lua
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not vim.uv.fs_stat(lazypath) then
vim.fn.system({
"git",
"clone",
"--filter=blob:none",
"https://github.com/folke/lazy.nvim.git",
"--branch=stable", -- latest stable release
lazypath,
})
end
vim.opt.rtp:prepend(lazypath)
require("lazy").setup({
"neovim/nvim-lspconfig",
{
"nvim-telescope/telescope.nvim",
branch = "0.1.x",
dependencies = {
"nvim-lua/plenary.nvim",
{
"nvim-telescope/telescope-fzf-native.nvim",
build = "make",
cond = vim.fn.executable("make") == 1,
},
},
},
})
vim.g.mapleader = " "
vim.g.maplocalleader = " "
local on_attach = function(client, bufno)
-- depricated since neovim 0.10
-- vim.api.nvim_buf_set_option(bufno, "omnifunc", "v:lua.vim.lsp.omnifunc")
vim.api.nvim_set_option_value("omnifunc", "v:lua.vim.lsp.omnifunc", { buf = bufno })
local ts = require("telescope.builtin")
local opts = { buffer = bufno }
vim.keymap.set("n", "<leader>e", vim.diagnostic.open_float)
vim.keymap.set("n", "K", vim.lsp.buf.hover, opts)
vim.keymap.set("n", "<C-k>", vim.lsp.buf.signature_help, opts)
vim.keymap.set("n", "gD", vim.lsp.buf.declaration, opts)
vim.keymap.set("n", "gd", vim.lsp.buf.definition, opts)
vim.keymap.set("n", "gtd", vim.lsp.buf.type_definition, opts)
vim.keymap.set("n", "gi", vim.lsp.buf.implementation, opts)
vim.keymap.set("n", "gu", ts.lsp_references, opts)
vim.keymap.set("n", "<leader>ca", vim.lsp.buf.code_action, opts)
vim.keymap.set("n", "<leader>cl", vim.lsp.codelens.run, opts)
vim.keymap.set("n", "<leader>r", vim.lsp.buf.rename, opts)
vim.keymap.set("n", "<leader>f", function()
vim.lsp.buf.format({ async = true })
end, opts)
end
local capabilities = vim.lsp.protocol.make_client_capabilities()
require("lspconfig")["gopls"].setup({
capabilities = capabilities,
settings = {},
on_attach = on_attach,
})
require("lspconfig")["golangci_lint_ls"].setup({
capabilities = capabilities,
settings = {},
on_attach = on_attach,
})
```
</details>

View file

@ -1,7 +1,7 @@
---
title: 'Compiling from source'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/installation/from-source.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/installation/from-source.en-us.md'
---
## Installation from source
@ -21,7 +21,7 @@ version is 20.
necessary. To be able to use these, you must have the `"$GOPATH/bin"` directory
on the executable path.
**Note 2**: Go version 1.21 or higher is required. However, it is recommended to
**Note 2**: Go version 1.22 or higher is required. However, it is recommended to
obtain the same version as the [continuous integration](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/.forgejo/workflows/testing.yml).
**Note 3**: If you want to avoid installing build dependencies manually,
@ -44,24 +44,24 @@ To work with tagged releases, the following commands can be used:
```bash
git branch -a
git checkout v1.21.2-0
git checkout v7.0.3
```
To build Forgejo from source at a specific tagged release (like v1.21.2-0), list the
To build Forgejo from source at a specific tagged release (like v7.0.3), list the
available tags and check out the specific tag.
List available tags with the following.
```bash
git tag -l
git checkout v1.21.2-0
git checkout v7.0.3
```
### Build
To build from source, the following programs must be present on the system:
- `go` v1.21 or higher, see [here](https://golang.org/dl/)
- `go` v1.22 or higher, see [here](https://golang.org/dl/)
- `node` 20 or higher with `npm`, see [here](https://nodejs.org/en/download/current)
- `make`
@ -102,16 +102,16 @@ TAGS="bindata" make build
```
In the default release build of the continuous integration system, the build
tags are: `TAGS="bindata sqlite sqlite_unlock_notify"`. The simplest
tags are: `TAGS="bindata timetzdata sqlite sqlite_unlock_notify"`. The simplest
recommended way to build from source is therefore:
```bash
TAGS="bindata sqlite sqlite_unlock_notify" make build
TAGS="bindata timetzdata sqlite sqlite_unlock_notify" make build
```
The `build` target is split into two sub-targets:
- `make backend` which requires [Go v1.21](https://golang.org/dl/) or greater.
- `make backend` which requires [Go v1.22](https://golang.org/dl/) or greater.
- `make frontend` which requires [Node.js 20](https://nodejs.org/en/download/current) or greater.
If pre-built frontend files are present it is possible to only build the backend:
@ -136,4 +136,4 @@ You can also supply a tag during the build process with the `-t` option, to make
### Testing
See [the section dedicated to testing](./testing/).
See [the section dedicated to testing](../testing/).

View file

@ -19,6 +19,7 @@ their needs.
- [Developer Certificate of Origin (DCO)](./dco/)
- [code.forgejo.org](./code-forgejo-org/)
- [next.forgejo.org](./next-forgejo-org/)
- [static pages](./static-pages/)
- [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking)
- [Localization](./localization/)
- [Base localization](./localization-english/)

View file

@ -3,6 +3,195 @@ title: Hardware infrastructure
license: 'CC-BY-SA-4.0'
---
## LXC Hosts
All LXC hosts are setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/).
```sh
name=forgejo-host
lxc-helpers.sh lxc_container_run $name -- sudo --user debian bash
```
### Unprivileged
```sh
name=forgejo-host
lxc-helpers.sh lxc_container_create --config "unprivileged" $name
echo "lxc.start.auto = 1" | sudo tee -a /var/lib/lxc/$name/config
lxc-helpers.sh lxc_container_start $name
lxc-helpers.sh lxc_container_user_install $name $(id -u) $USER
```
### Docker enabled
```sh
name=forgejo-host
lxc-helpers.sh lxc_container_create --config "docker" $name
echo "lxc.start.auto = 1" | sudo tee -a /var/lib/lxc/$name/config
lxc-helpers.sh lxc_container_start $name
lxc-helpers.sh lxc_install_docker $name
lxc-helpers.sh lxc_container_user_install $name $(id -u) $USER
```
### Docker and LXC enabled
```sh
name=forgejo-host
ipv4=10.85.12
ipv6=fc33
lxc-helpers.sh lxc_container_create --config "docker lxc" $name
echo "lxc.start.auto = 1" | sudo tee -a /var/lib/lxc/$name/config
lxc-helpers.sh lxc_container_start $name
lxc-helpers.sh lxc_install_docker $name
lxc-helpers.sh lxc_install_lxc forgejo-runner-host $ipv4 $ipv6
lxc-helpers.sh lxc_container_user_install $name $(id -u) $USER
```
## Host reverse proxy
The reverse proxy on a host forwards to the designated LXC container with
something like the following examples in
`/etc/nginx/sites-available/example.com`, where A.B.C.D is the
IP allocated to the LXC container running the web service.
And symlink:
```sh
ln -s /etc/nginx/sites-available/example.com /etc/nginx/sites-enabled/example.com
```
The certificate is obtained once and automatically renewed with:
```
sudo apt-get install certbot python3-certbot-nginx
sudo certbot -n --agree-tos --email contact@forgejo.org -d example.com --nginx
```
### Forgejo example
```
server {
listen 80;
listen [::]:80;
server_name example.com;
location / {
deny 47.76.209.138; # crawler that does not obey robots.txt
deny 47.76.99.127; # crawler that does not obey robots.txt
proxy_pass http://A.B.C.D:8080;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto https;
client_max_body_size 2G;
#
# http://nginx.org/en/docs/http/websocket.html
#
proxy_set_header Connection $http_connection;
proxy_set_header Upgrade $http_upgrade;
include proxy_params;
}
}
```
### GitLab example
```nginx
server {
listen 80;
listen [::]:80;
server_name example.com;
location / {
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Frame-Options SAMEORIGIN;
client_body_timeout 60;
client_max_body_size 200M;
send_timeout 1200;
lingering_timeout 5;
proxy_buffering off;
proxy_connect_timeout 90;
proxy_send_timeout 300;
proxy_read_timeout 600s;
proxy_pass http://example.com;
proxy_http_version 1.1;
}
}
```
### Vanila example
```nginx
server {
listen 80;
listen [::]:80;
server_name example.com;
location / {
proxy_pass http://A.B.C.D;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto https;
}
}
```
## Forgejo runners
The LXC container in which the runner is installed must have capabilities that support the backend.
- docker:// needs a Docker enabled container
- lxc:// needs a Docker and LXC enabled container
The runners it contains are not started at boot, it must be done manually. The bash history has the command line to do so.
### Installation
```shell
version=3.4.1
sudo wget -O /usr/local/bin/forgejo-runner-$version https://code.forgejo.org/forgejo/runner/releases/download/v$version/forgejo-runner-$version-linux-amd64
sudo chmod +x /usr/local/bin/forgejo-runner-$version
echo 'export TERM=xterm-256color' >> .bashrc
```
### Creating a runner
Multiple runners can co-exist on the same machine. To keep things
organized they are located in a directory that is the same as the URL
from which the token is obtained. For instance
DIR=codeberg.org/forgejo-integration means that the token was obtained from the
https://codeberg.org/forgejo-integration organization.
If a runner only provides unprivileged docker containers, the labels
in `config.yml` should be:
`labels: ['docker:docker://node:20-bookworm']`.
If a runner provides LXC containers and unprivileged docker
containers, the labels in `config.yml` should be
`labels: ['self-hosted:lxc://debian:bookworm', 'docker:docker://node:20-bookworm']`.
```shell
name=myrunner
mkdir -p $DIR ; cd $DIR
forgejo-runner generate-config > config-$name.yml
## edit config-$name.yml and adjust the `labels:`
## Obtain a $TOKEN from https://$DIR
forgejo-runner-$version register --no-interactive --token $TOKEN --name runner --instance https://codeberg.org
forgejo-runner-$version --config config-$name.yml daemon |& cat -v > runner.log &
```
## Octopuce
[Octopuce provides hardware](https://codeberg.org/forgejo/sustainability) managed by [the devops team](https://codeberg.org/forgejo/governance/src/branch/main/TEAMS.md#devops). It can only be accessed via SSH.
@ -17,19 +206,11 @@ firefox http://private.forgejo.org
### Containers
It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/).
- `fogejo-host`
Dedicated to http://private.forgejo.org
- LXC creation
```sh
lxc-helpers.sh lxc_container_create --config "docker" forgejo-host
lxc-helpers.sh lxc_container_start forgejo-host
lxc-helpers.sh lxc_install_docker forgejo-host
lxc-helpers.sh lxc_container_user_install forgejo-host $(id -u) $USER
```
- Docker enabled
- upgrades checklist:
```sh
emacs /home/debian/run-forgejo.sh # change the `image=`
@ -44,66 +225,18 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
Has runners installed to run against private.forgejo.org
- LXC creation
```sh
lxc-helpers.sh lxc_container_create --config "docker" forgejo-runner-host
lxc-helpers.sh lxc_container_start forgejo-runner-host
lxc-helpers.sh lxc_install_docker forgejo-runner-host
lxc-helpers.sh lxc_install_lxc forgejo-runner-host 10.85.12 fc33
lxc-helpers.sh lxc_container_user_install forgejo-runner-host $(id -u) $USER
```
- Docker and LXC enabled 10.85.12 fc33
## Hetzner
All hardware is running Debian GNU/linux bookworm.
All hardware machines are running Debian GNU/linux bookworm. They are LXC hosts
setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/).
### hetzner01
> **NOTE:** only use [EX101 with a ASRockRack W680D4U-1L motherboard](https://forum.hetzner.com/index.php?thread/31135-all-ex101-with-asustek-w680-crash-on-sequential-read/).
https://hetzner01.forgejo.org runs on an [EX101](https://www.hetzner.com/dedicated-rootserver/ex101) Hetzner hardware.
### vSwitch
There is no backup, no redundancy and is dedicated to Forgejo runner instances.
If the hardware reboots, the runners do not restart automatically, they have to be restarted manually.
It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/):
- `forgejo-runners`
Dedicated to Forgejo runners for the https://codeberg.org/forgejo organization.
```sh
lxc-helpers.sh lxc_container_run forgejo-runners -- sudo --user debian bash
cd codeberg.org/forgejo/
forgejo-runner-3.2.0 --config config.yml daemon >& runner.log &
```
- `runner01-lxc`
Dedicated to Forgejo runners for the https://code.forgejo.org
organization with two labels: **docker** and **self-hosted**.
- https://code.forgejo.org/forgejo
- https://code.forgejo.org/actions
- https://code.forgejo.org/forgejo-integration
- https://code.forgejo.org/forgejo-contrib
```sh
lxc-helpers.sh lxc_container_run runner01-lxc -- sudo --user debian bash
cd code.forgejo.org
for runner in forgejo-contrib forgejo forgejo-integration actions ; do ( cd $runner ; HOME=/srv/$runner forgejo-runner-3.2.0 --config config.yml daemon >&runner.log & ) ; done
```
The runners are installed with something like:
```sh
sudo wget -O /usr/local/bin/forgejo-runner-3.2.0 https://code.forgejo.org/forgejo/runner/releases/download/v3.2.0/forgejo-runner-3.2.0-linux-amd64
sudo chmod +x /usr/local/bin/forgejo-runner-3.2.0
```
### hetzner{02,03}
https://hetzner02.forgejo.org & https://hetzner03.forgejo.org run on [EX44](https://www.hetzner.com/dedicated-rootserver/ex44) Hetzner hardware.
A vSwitch is assigned via the Robot console on both servers
A vSwitch is assigned via the Robot console on all servers for backend communications
and [configured](https://docs.hetzner.com/robot/dedicated-server/network/vswitch#example-debian-configuration)
in /etc/network/interfaces for each of them with something like:
@ -116,18 +249,15 @@ iface enp5s0.4000 inet static
mtu 1400
```
#### Root filesystem backups
The IP address ends with the same number as the hardware (hetzner02 => .2).
- `hetzner03:/etc/cron.daily/backup-hetzner02`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /srv --exclude /var/lib/lxc 10.53.100.2:/ /srv/backups/hetzner02/`
- `hetzner02:/etc/cron.daily/backup-hetzner03`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /srv --exclude /var/lib/lxc 10.53.100.3:/ /srv/backups/hetzner03/`
### DRBD
#### DRBD
DRBD is [configured](https://linbit.com/drbd-user-guide/drbd-guide-9_0-en/#p-work) like in the following example with hetzner02 as the primary and hetzner03 as the secondary:
DRBD is configured with hetzner02 as the primary and hetzner03 as the secondary:
```
```sh
$ apt-get install drbd-utils
$ cat /etc/drbd.d/r0.res
resource r0 {
net {
# A : write completion is determined when data is written to the local disk and the local TCP transmission buffer
@ -146,7 +276,7 @@ resource r0 {
volume 0 {
# device name
device /dev/drbd0;
# specify disk to be used for devide above
# specify disk to be used for device above
disk /dev/nvme0n1p5;
# where to create metadata
# specify the block device name when using a different disk
@ -162,21 +292,28 @@ resource r0 {
}
}
}
$ sudo drbdadm create-md r0
$ sudo drbdadm up r0
```
The DRBD device is mounted on `/var/lib/lxc`.
On hetzner02 (the primary), [pretend all is in sync](https://linbit.com/drbd-user-guide/drbd-guide-9_0-en/#s-skip-initial-resync) to save the initial bitmap sync since
there is actually no data at all.
In `/etc/fstab` there is a noauto line:
```sh
sudo drbdadm new-current-uuid --clear-bitmap r0/0
```
The DRBD device is mounted on `/var/lib/lxc` in `/etc/fstab` there is a noauto line:
```
/dev/drbd0 /var/lib/lxc ext4 noauto,defaults 0 0
```
To prevent split brain situations a manual step is required at boot
time, on the machine that is going to be the primary, which is
hetzner02 in a normal situation.
time, on the machine that is going to be the primary.
```sh
sudo drbdadm up r0
sudo drbdsetup status
sudo drbdadm primary r0
sudo mount /var/lib/lxc
@ -185,37 +322,114 @@ sudo lxc-ls -f
sudo drbdsetup status
```
#### Fast storage on /srv
### hetzner{01,04}
The second disk on each node is mounted on /srv and can be used when
fast storage is needed and there is no need for backups, such as Forgejo runners.
https://hetzner{01,04}.forgejo.org run on [EX101](https://www.hetzner.com/dedicated-rootserver/ex101) Hetzner hardware.
#### LXC
LXC is setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/).
The `/etc/default/lxc-net` file is the same on both machines:
```sh
lxc-helpers.sh lxc_install_lxc_inside 10.41.13 fc29
```
USE_LXC_BRIDGE="true"
LXC_ADDR="10.6.83.1"
LXC_NETMASK="255.255.255.0"
LXC_NETWORK="10.6.83.0/24"
LXC_DHCP_RANGE="10.6.83.2,10.6.83.254"
LXC_DHCP_MAX="253"
LXC_IPV6_ADDR="fc16::216:3eff:fe00:1"
LXC_IPV6_MASK="64"
LXC_IPV6_NETWORK="fc16::/64"
LXC_IPV6_NAT="true"
#### Disk partitioning
- First disk
- OS
- a partition mounted on /srv where non precious data goes such as the LXC containers with runners.
- Second disk
- configured with DRBD for precious data.
#### Root filesystem backups
- `hetzner01:/etc/cron.daily/backup-hetzner04`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /precious --exclude /srv --exclude /var/lib/lxc 10.53.100.4:/ /srv/backups/hetzner04/ >& /var/log/$(basename $0).log`
- `hetzner04:/etc/cron.daily/backup-hetzner01`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /precious --exclude /srv --exclude /var/lib/lxc 10.53.100.1:/ /srv/backups/hetzner01/ >& /var/log/$(basename $0).log`
#### LXC containers
- `forgejo-runners` (hetzner01)
Dedicated to Forgejo runners for the https://codeberg.org/forgejo organization.
- Docker enabled
- codeberg.org/forgejo/config\*.yml
- `runner01-lxc` (hetzner01)
Dedicated to Forgejo runners for https://code.forgejo.org.
- Docker and LXC enabled 10.194.201 fc35
- code.forgejo.org/forgejo/config\*.yml
- code.forgejo.org/actions/config\*.yml
- code.forgejo.org/forgejo-integration/config\*.yml
- code.forgejo.org/forgejo-contrib/config\*.yml
- code.forgejo.org/f3/config\*.yml
- code.forgejo.org/forgefriends/config\*.yml
- `forgefriends-forum` (hetzner04)
Dedicated to https://forum.forgefriends.org
- Docker enabled
- `forgefriends-gitlab` (hetzner04)
Dedicated to https://lab.forgefriends.org
- Docker enabled
- `forgefriends-cloud` (hetzner04)
Dedicated to https://cloud.forgefriends.org
- Docker enabled
- `gna-forgejo` (hetzner04)
Dedicated to https://forgejo.gna.org
- Docker enabled
- `gna-forum` (hetzner04)
Dedicated to https://forum.gna.org
- Docker enabled
### hetzner{02,03}
https://hetzner02.forgejo.org & https://hetzner03.forgejo.org run on [EX44](https://www.hetzner.com/dedicated-rootserver/ex44) Hetzner hardware.
#### LXC
```sh
lxc-helpers.sh lxc_install_lxc_inside 10.6.83 fc16
```
#### Disk partitioning
- First disk
- OS
- a partition configured with DRBD for precious data mounted on /var/lib/lxc
- Second disk
- non precious data such as the LXC containers with runners.
#### Root filesystem backups
- `hetzner03:/etc/cron.daily/backup-hetzner02`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /srv --exclude /var/lib/lxc 10.53.100.2:/ /srv/backups/hetzner02/`
- `hetzner02:/etc/cron.daily/backup-hetzner03`
`rsync -aHS --delete-excluded --delete --numeric-ids --exclude /proc --exclude /dev --exclude /sys --exclude /srv --exclude /var/lib/lxc 10.53.100.3:/ /srv/backups/hetzner03/`
#### Public IP addresses
The public IP addresses attached to the hosts are not failover IPs that can be moved from one host to the next.
The DNS entry needs to be updated if the primary hosts changes.
When additional IP addresses are attached to the server, they are added to `/etc/network/interfaces` like
65.21.67.71 and 2a01:4f9:3081:51ec::102 below.
ipv4 65.21.67.71 and ipv6 2a01:4f9:3081:51ec::102 below.
```
auto enp5s0
@ -258,54 +472,13 @@ add chain ip code prerouting {
with `nft -f /root/code.nftables`.
#### Reverse proxy
The reverse proxy forwards to the designated LXC container with
something like the following in
`/etc/nginx/sites-enabled/code.forgejo.org`, where 10.6.83.195 is the
IP allocated to the LXC container running the web service:
```
server {
server_name code.forgejo.org;
location / {
deny 47.76.209.138; # crawler that does not obey robots.txt
deny 47.76.99.127; # crawler that does not obey robots.txt
proxy_pass http://10.6.83.195:8080;
client_max_body_size 2G;
#
# http://nginx.org/en/docs/http/websocket.html
#
proxy_set_header Connection $http_connection;
proxy_set_header Upgrade $http_upgrade;
include proxy_params;
}
}
```
The LE certificate is obtained once and automatically renewed with:
```
sudo certbot -n --agree-tos --email contact@forgejo.org -d code.forgejo.org --nginx
```
#### Containers
It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgejo/lxc-helpers/).
- `fogejo-code` on hetzner02
Dedicated to https://code.forgejo.org
- LXC creation
```sh
lxc-helpers.sh lxc_container_create --config "docker" forgejo-code
lxc-helpers.sh lxc_container_start forgejo-code
lxc-helpers.sh lxc_install_docker forgejo-code
lxc-helpers.sh lxc_container_user_install forgejo-code $(id -u) $USER
```
- Docker enabled
- upgrades checklist:
- `ssh -t debian@hetzner02.forgejo.org lxc-helpers.sh lxc_container_run forgejo-code -- sudo --user debian bash`
```sh
@ -319,12 +492,14 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
bash -x /home/debian/run-forgejo.sh
docker logs -n 200 -f forgejo
```
- Rotating 30 days backups happen daily `/etc/cron.daily/forgejo-code-backup.sh`
- Add code.forgejo.org to the forgejo.org SPF record
- `forgejo-next` on hetzner02
Dedicated to https://next.forgejo.org
- LXC creation same as code.forgejo.org
- Docker enabled
- `/etc/cron.hourly/forgejo-upgrade` runs `/home/debian/run-forgejo.sh > /home/debian/run-forgejo-$(date +%d).log`
- When a new major version is published (8.0 for instance) `run-forgejo.sh` must be updated with it
- Reset everything
@ -335,7 +510,6 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
sudo mv /srv/forgejo /srv/forgejo.old
bash -x /home/debian/run-forgejo.sh
```
and create a user with the CLI using the example from `/home/debian/run-forgejo.sh`
- `/home/debian/next.nftables`
```
add table ip next;
@ -346,9 +520,55 @@ It hosts LXC containers setup with [lxc-helpers](https://code.forgejo.org/forgej
ip daddr 65.21.67.65 tcp dport { 2020 } dnat to 10.6.83.213;
};
```
- Add to `iface enp5s0 inet static` in `/etc/network/interfaces`
```
up nft -f /home/debian/next.nftables
```
```
- `/etc/nginx/sites-available/next.forgejo.org` same as `/etc/nginx/sites-available/code.forgejo.org`
Rotating 30 days backups happen daily `/etc/cron.daily/forgejo-code-backup.sh`
```
- `forgejo-v7` on hetzner02
Dedicated to https://v7.next.forgejo.org
- Docker enabled
- `/etc/cron.hourly/forgejo-upgrade` runs `/home/debian/run-forgejo.sh > /home/debian/run-forgejo-$(date +%d).log`
- Reset everything
```sh
docker stop forgejo
docker rm forgejo
sudo rm -fr /srv/forgejo.old
sudo mv /srv/forgejo /srv/forgejo.old
bash -x /home/debian/run-forgejo.sh
```
- `/home/debian/v7.nftables`
```
add table ip v7;
flush table ip v7;
add chain ip v7 prerouting {
type nat hook prerouting priority 0;
policy accept;
ip daddr 65.21.67.65 tcp dport { 2070 } dnat to 10.6.83.179;
};
```
- Add to `iface enp5s0 inet static` in `/etc/network/interfaces`
```
up nft -f /home/debian/v7.nftables
```
```
- `/etc/nginx/sites-available/v7.forgejo.org` same as `/etc/nginx/sites-available/code.forgejo.org`
```
- `static-pages` on hetzner02
See [the static pages documenation](../static-pages/) for more information.
- Unprivileged
- `runner-forgejo-helm` on hetzner03
@ -360,60 +580,18 @@ The website https://forgejo.org is hosted at
https://uberspace.de/. The https://codeberg.org/forgejo/website/ CI
has credentials to push HTML pages there.
## Installing Forgejo runners
## ubuntu-runner.forgejo.org
### Preparing the LXC hypervisor
The ubuntu-runner.forgejo.org virtual machine is hosted in the OVH
public cloud under the same account as the domain names. It is
dedicated to a [Forgejo runner for the benefit of the snap package](https://codeberg.org/forgejo-contrib/snap/issues/9) of
Forgejo.
```shell
git clone https://code.forgejo.org/forgejo/lxc-helpers/
As of April 2024 it is unclear how to run snapd in an LXC nested
container. When [this is resolved](https://code.forgejo.org/forgejo/lxc-helpers/issues/24), the machine can be destroyed and the
runner moved to an LXC container instead.
lxc-helpers.sh lxc_prepare_environment
sudo lxc-helpers.sh lxc_install_lxc_inside 10.120.13
```
Forgejo contributors with SSH access to this machine are:
### Creating an LXC container
```shell
lxc-helpers.sh lxc_container_create forgejo-runners
lxc-helpers.sh lxc_container_start forgejo-runners
lxc-helpers.sh lxc_install_docker forgejo-runner
lxc-helpers.sh lxc_install_lxc forgejo-runner 10.85.12 fc33
lxc-helpers.sh lxc_container_user_install forgejo-runners $(id -u) $USER
lxc-helpers.sh lxc_container_run forgejo-runners -- sudo --user debian bash
sudo apt-get update
sudo apt-get install -y wget emacs-nox
lxc-helpers.sh lxc_prepare_environment
sudo wget -O /usr/local/bin/forgejo-runner https://code.forgejo.org/forgejo/runner/releases/download/v3.3.0/forgejo-runner-3.3.0-linux-amd64
sudo chmod +x /usr/local/bin/forgejo-runner
echo 'export TERM=vt100' >> .bashrc
```
### Creating a runner
Multiple runners can co-exist on the same machine. To keep things
organized they are located in a directtory that is the same as the url
from which the token is obtained. For instance
DIR=codeberg.org/forgejo-integration means that the token was obtained from the
https://codeberg.org/forgejo-integration organization.
If a runner only provides unprivileged docker containers, the labels
in `config.yml` should be:
`labels: ['docker:docker://node:20-bookworm']`.
If a runner provides LXC containers and unprivileged docker
containers, the labels in `config.yml` should be
`labels: ['self-hosted:lxc://debian:bookworm', 'docker:docker://node:20-bookworm']`.
```shell
mkdir -p $DIR ; cd $DIR
forgejo-runner generate-config > config.yml
## edit config.yml and adjust the `labels:`
## Obtain a $TOKEN from https://$DIR
forgejo-runner register --no-interactive --token $TOKEN --name runner --instance https://codeberg.org
forgejo-runner --config config.yml daemon |& cat -v > runner.log &
```
#### codeberg.org config.yml
- `fetch_timeout: 30s` # because it can be slow at times
- `fetch_interval: 60s` # because there is throttling and 429 replies will mess up the runner
- https://codeberg.org/popey
- https://codeberg.org/earl-warren

View file

@ -13,16 +13,20 @@ Weblate is [configured to propose pull requests](https://translate.codeberg.org/
to the Forgejo repository with new translations. These pull requests should be **squash merged** into the Forgejo
development branch as follows:
- announce 15 minutes before in the chatroom `@room the translations will be locked for maintenance in 15 minutes, make sure you don't try to save a translation when that happens as it will be lost.`
- announce in the chatroom: `@room the translations will be locked for maintenance in about 15 minutes. Make sure you don't try to save a translation when that happens as it will be lost.`
- go to the [Weblate repository admin page](https://translate.codeberg.org/projects/forgejo/forgejo/#repository)
- click lock
- click `Commit`. This is done optionally to make tests run before interrupting anyone, to reduce the total maintenance time
- post a "Warning" [announcement in Weblate](https://translate.codeberg.org/projects/forgejo/forgejo/#announcement): `The translations will be locked for maintenance soon. Make sure you don't try to save a translation when that happens as it will be lost.`. Make sure to unckeck the notification option.
- wait 15 minutes
- click `Lock`
- reload the page
- check the number of commits
- verify there are 0 pending changes
- go to the pull request and wait until it is rebased and has the same number of commits
- squash merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
- click reset
- click unlock
- squash-merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
- click `Reset`
- click `Unlock`
- remove Weblate announcement
## Merging a pull request that changes translations
@ -34,5 +38,54 @@ are merged as explained above. Only the end of the sequence changes:
- squash merge the pending `[I18N]` pull request ([similar to this example](https://codeberg.org/forgejo/forgejo/pulls/2317))
- merge the PR (after resolving conflicts due to the merge of the Weblate changes)
- click reset
- click unlock
- click `Reset`
- click `Unlock`
## Resolving failures
### Weblate locked due to network error
Sometimes a connectivity error with Codeberg or it's unavailability can cause Weblate to lock. The lock error looks like this:
```
kex_exchange_identification: Connection closed by remote host
Connection closed by 217.197.91.145 port 22
fatal: Could not read from remote repository.
Please make sure you have the correct access rights
and the repository exists.
(128)
```
Weblate will retry connection attempts but it takes hours before it does that. If Codeberg is currently [available](https://status.codeberg.eu/) and working, the project can simply be unlocked manually to allow the translators to keep working.
### Weblate was not reset before unlocking
If Weblate was not reset after a translation squash-merge was performed, and it already has new edits, the following steps must be taken to resolve failing rebase and save the new edits:
1. Lock Weblate if it didn't lock itself yet due to a rebase error
2. Make sure there are no [pending changes](https://translate.codeberg.org/projects/forgejo/forgejo/#repository). If there are, click `Commit`
3. Download current [translation files](https://translate.codeberg.org/download/forgejo/forgejo/?format=zip) just in case something goes wrong
4. Add internal Weblate git repository to your remotes and fetch it: `git remote add weblate https://translate.codeberg.org/git/forgejo/forgejo`, `git fetch -u weblate`
5. Checkout into it's branch to see which commits it contains: `git checkout weblate/forgejo`. Identify the new commits that were not squash-merged into the Forgejo repository yet
6. Checkout a new branch from `forgejo` branch: `git switch forgejo`, `git checkout -b i18n-weblate-recovery`
7. Cherry-pick the new commits into this new branch: `git cherry-pick <commit>`
8. Publish this branch and open a PR
9. Wait for the PR to be merged
10. Click `Reset`
11. Click `Update`
12. Click unlock
### Commit changing non-base locales was merged before Weblate
If a commit changing translation files other than `en_US.ini` was merged before all changes from Weblate were merged, it could have caused Weblate to lock itself due to failed rebase.
If the rebase did succeed, everything is ok and no steps need to be taken, just be more cautious with merges next time.
If Weblate failed to rebase, the following steps must be taken:
1. Make a PR that reverts the commit that caused the breakage
2. Merge this PR
3. Make Weblate commit and push all changes
4. Merge the Weblate PR
5. Rebase the commit(s) of the PR that caused the breakage on top of the new Weblate commit, open a new PR
Alternatively the same steps as in `Weblate was not reset before unlocking` can be taken, except that the conflicts must be resolved with Weblate commits instead of the breaking PR commits.

View file

@ -9,11 +9,11 @@ Forgejo base localization is English. This means that all translations are deriv
English localization strings are stored in the file `options/locale/locale_en-US.ini`. Strings are [translated](../localization) on Weblate and string management is partially done by it.
When a new string needs to be added to Forgejo, it must be added to the base language to be picked up by Weblate. Optionally, if the author knows other languages, string translations for other languages can be added so they don't need to be translated for those languages after the PR is merged. This is not necessary and translation can be delegated to the translators at Weblate.
When a new string needs to be added to Forgejo, it must be added to the base language to be picked up by Weblate.
When a string key needs to be changed, it must be mass-changed for all languages into which the string has already been translated, so that existing translations aren't lost.
When a string needs to be deleted, it should only be deleted for the base language. Weblate will delete strings for other languages after the PR is merged.
When an unused string needs to be deleted, it should be only deleted for the base language to avoid merge conflicts. The string will disappear from all translations automatically after the PR is merged.
## Localization style

View file

@ -3,72 +3,87 @@ title: Localization
license: 'CC-BY-SA-4.0'
---
Forgejo is translated via Weblate - libre web-based translation platform.
Forgejo is translated via Weblate, a libre web-based translation platform.
## Translating via Weblate
The Weblate project of Forgejo localization is publicly available at [Codeberg Translate](https://translate.codeberg.org/projects/forgejo/forgejo/) Weblate instance.
The Forgejo project's localization project is publicly available via the [Codeberg Translate](https://translate.codeberg.org/projects/forgejo/forgejo/) Weblate instance.
### Translation guidelines
1. Please only suggest changes that will benefit all potential users of the translation. Do not suggest changes that will only make the translation better in cases specific to you or your Forgejo instance. Instead you can customize your instance separately from Forgejo upstream.
2. Try to keep the translation beginner-friendly.
3. Remember that you're not obligated to do the translation. If you're unsure about translation, feel free to leave it for somebody else to translate later.
1. Only suggest changes that benefit all users of the translation. Please do not suggest changes that will only make the translation better in cases specific to any self-hosted Forgejo instance. Instead customize such instances separately from Forgejo upstream.
2. Keep the translation as beginner-friendly as possible.
3. Users are not obligated to complete any translation. When unsure about the translation, feel free to leave it for others to translate.
### Discovering the translation
Go to the [Project](https://translate.codeberg.org/projects/forgejo/forgejo/) page. You'll see the list of languages that are currently available for translation. Click on your language.
Go to the [Project](https://translate.codeberg.org/projects/forgejo/forgejo/) page for a list of languages that are currently available for translation.
From the language page you can browse all translation strings, as well as untranslated, unfinished and failing ones.
From the language page it is possible to browse all translation strings, as well as untranslated, unfinished and failing translations.
### Suggesting changes
You can suggest changes and additions to the existing translation anonymously: find the string for which you want to suggest a change, type your change in, and click "Suggest". Your change will be checked before being accepted. Most contributors are volunteers, this can take a while.
Anonymous suggestions for changes and additions to the existing translation can be submitted by finding the string for which to suggest a change, typing the change in, and then clicking "Suggest".
All suggested change will be checked before being accepted. Since most localization members are likewise volunteers, this can take a while.
### Making direct changes, accepting suggestions
Making direct changes requires a [Codeberg](https://codeberg.org/) account. Use it to log into [Codeberg Translate](https://translate.codeberg.org/).
Direct changes require a [Codeberg](https://codeberg.org/) account which can be used to access the [Codeberg Translate](https://translate.codeberg.org/) account.
If the string is not translated or approved, you can edit it and use the "Save" button to save the change. You can also apply existing suggestions by clicking the checkmark icon, or reject, optionally specifying the rejection reason.
If the translation is not approved it is possible to edit the string again and use the "Save" button to save the change. Existing suggestions can either be applied, or rejected by optionally specifying the rejection reason.
If the string is translated and approved, it can only be changed by a Forgejo Localization team member, but everyone else is still able suggest changes.
Once the string is translated and approved it can only be changed by a Forgejo **Localization Team** member, though everyone else is still able suggest changes.
To protect the existing translations from vandalism, all strings imported from Gitea were automatically marked as approved.
### Adding a new language
If your language is not available in the language list, you must add first it before translating.
If your language is not available in the language list it must be added first before translating.
To add a new language, go to the [page for starting new translation](https://translate.codeberg.org/new-lang/forgejo/forgejo/), select your language and click "Start new translation".
To add a new language, go to the [page for starting new translation](https://translate.codeberg.org/new-lang/forgejo/forgejo/), select a language and click "Start new translation".
### E-mail privacy
By default, Weblate will use your primary e-mail address for your contributions. If you want to adjust this behavior, go to [Weblate settings - Account](https://translate.codeberg.org/accounts/profile/#account) and select a different e-mail under "Commit e-mail" section. You can select `@users.noreply.translate.codeberg.org` address to avoid using any real e-mail address.
## Joining the Localization team
If you want to be more involved in maintaining the translation - consider becoming a part of the Localization team.
In order to apply to the team you must open a new issue at [forgejo/governance](https://codeberg.org/forgejo/governance) repository. See [previous applications](https://codeberg.org/forgejo/governance/issues?q=application+to+the+localization+team&state=closed) for inspiration.
In your application message, please include:
- your motivation for becoming a member
- your experience at translating other projects and using Weblate. e.g. link(s) to your public translation profile(s) or contributions
Application process takes 2 weeks or more. However, it doesn't prevent you from working on the translation: you can add suggestions which you will be able accept later being a team member, translate new strings, add comments and discuss the translation.
It is a good idea to work on the translation first for a bit, before applying to the Localization team, to see how the workflow looks like.
Please apply to the team only if you want your actions as a team member to be beneficial to all translation users.
By default, Weblate will use an accounts primary e-mail address for all contributions. If you want to adjust this behavior go to [Weblate settings - Account](https://translate.codeberg.org/accounts/profile/#account) and select a different e-mail under "Commit e-mail" section. Select `@users.noreply.translate.codeberg.org` address to avoid using a unmasked e-mail address.
## Discussing the translation
Ask questions, clarify string meaning, report vandalism and suggest changes to source strings in [Matrix room](https://matrix.to/#/#forgejo-localization:matrix.org) or [issues](https://codeberg.org/forgejo/forgejo/issues). For this you don't need to be a member of the Localization team.
To ask questions, clarify string meaning, report vandalism or suggest changes to source strings post in [Matrix room](https://matrix.to/#/#forgejo-localization:matrix.org) or [issues](https://codeberg.org/forgejo/forgejo/issues). Doing this is not restricted to members of the **Localization Team**.
## Joining the Localization Team
Any [Codeberg Translate](https://translate.codeberg.org) user is able to suggest translations, translate new strings, add comments and discuss existing translations with our **Localization Team**.
If you would like to maintain the translation, join the **Localization Team** as a member by sending us an application.
However, before doing that, we recommend working on translations independently before applying. This allows time to get used to the workflow and collaborating within the **Localization Team**. Members are able to accept their own suggestions.
### Applying
In order to become a member of the team apply by opening a new issue at [forgejo/governance](https://codeberg.org/forgejo/governance) repository. See [previous applications](https://codeberg.org/forgejo/governance/issues?q=application+to+the+localization+team&state=closed) for inspiration.
In the application message, state the following:
- Motivation for becoming a member.
- Experience translating other projects and using Weblate. E.g. link(s) to public translation profile(s) or contribution(s).
The application process will take approximately two (2) weeks (or more) to complete.
### Responsibilities
Becoming a part of any of our team comes with a couple of responsibilities:
- Members must act in accordance to the [Code of Conduct](https://codeberg.org/forgejo/code-of-conduct).
- Members must act in accordance to all other rules and process that Forgejo agrees on through [its decision making process](https://codeberg.org/forgejo-contrib/governance/src/branch/main/DECISION-MAKING.md).
Translations should aim to target people of different backgrounds across all reasonable end user locales.
Since text is highly subjective, this is simply a goal that should be striven for and not a measurable requirement. Remain receptive to creative feedback from the **Localization Team** members.
## Troubleshooting
If you have problems using Weblate, there are multiple support channels available:
When having problems using Weblate, there are multiple support channels available:
- [Weblate documentation](https://docs.weblate.org)
- [Weblate issues](https://github.com/WeblateOrg/weblate/issues)

View file

@ -7,20 +7,10 @@ _This is the developer documentation for Forgejo Next, covering technical
details for Forgejo contributors.
[Go to end-user documentation for service overview.](../../user/forgejo-next/)_
https://next.forgejo.org, also known as Forgejo Next, is Forgejo's
official testing and demonstration instance. The specific version of
Forgejo running on this instance varies depending on the status of the
latest release branch.
The Forgejo instances running under the `next.forgejo.org` domain are official testing and demonstration instance. They are updated daily. The data they contain may be wiped out without notice.
Typically, the instance will be running the daily build straight from the
`forgejo` branch, meaning it contains experimental code that will be
included in the next major version of Forgejo.
- https://next.forgejo.org runs the tip of the [forgejo branch](https://codeberg.org/forgejo/forgejo/src/branch/forgejo).
- https://v7.next.forgejo.org runs from the [codeberg.org/forgejo-experimental/forgejo:7](https://codeberg.org/forgejo-experimental/-/packages/container/forgejo/7) OCI image. It is built from the latest commit of the most recent branch.
When a release branch is created and release candidates are posted,
Forgejo Next will be switched to the latest release candidate. Release
candidates are to be deployed until a stable release is
available. next.forgejo.org will then be upgraded back to the
`forgejo` branch.
For details on the hardward from which it is running, [checkout the section in the
For details on the hardware from which it is running, [checkout the section in the
infrastructe documentation](../infrastructure/#containers).

View file

@ -0,0 +1,121 @@
---
title: Static pages
license: 'CC-BY-SA-4.0'
---
LXC container dedicated to hosting static HTML pages.
# LXC container
See the [static-pages section in the infrastructure documentation](../infrastructure/).
# SSL on the LXC host
Each domain has a `/etc/nginx/sites-available/f3.forgefriends.forgejo.org` file similar to the following
on the host where the LXC container resides.
```nginx
server {
listen 80;
listen [::]:80;
server_name f3.forgefriends.forgejo.org;
location / {
proxy_pass http://10.6.83.106:80;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}
```
Obtain the certificate:
```sh
ln -sf /etc/nginx/sites-available/f3.forgefriends.forgejo.org /etc/nginx/sites-enabled/f3.forgefriends.forgejo.org
sudo certbot -n --agree-tos --email contact@forgejo.org -d f3.forgefriends.forgejo.org --nginx
```
# Creation in the LXC container
With the example of `f3.forgefriends.forgejo.org` and
`f3.forgefriends.org` serving the same content.
## login
From the LXC host:
```sh
lxc-helpers.sh lxc_container_run static-pages -- sudo --user $USER bash
```
## nginx
```
$ cat /etc/nginx/sites-enabled/f3.forgefriends.org
server {
listen 80;
listen [::]:80;
server_name f3.forgefriends.org f3.forgefriends.forgejo.org;
root /var/www/f3.forgefriends.org;
location / {
try_files $uri $uri/ =404;
}
}
```
## clone
```sh
git clone https://code.forgejo.org/f3/html-documentation /var/www/f3.forgefriends.org
```
# Update in the LXC container
## Webhook
Create a `POST` webhook with the URL `https://f3.forgefriends.forgejo.org/.well-known/forgejo/f3.forgefriends.org` on https://code.forgejo.org/f3/html-documentation. It is expected to fail with 404, the information will be extracted from the web server logs.
To verify that it works:
- `journalctl -f --unit static-pages`
- `Test delivery` at https://code.forgejo.org/f3/html-documentation/settings/hooks/4
## Service
### git pull on change
```sh
$ cat /usr/local/bin/static-pages.sh
#!/bin/bash
sudo tail -f /var/log/nginx/access.log | sed --silent --regexp-extended --unbuffered --expression 's|.*.well-known/forgejo/([^ /]+) .*|\1|p' | while read server ; do
d="/var/www/$server"
if test -d "$d" ; then
echo "update $server"
cd "$d"
git pull
else
echo "unknown server $server"
fi
done
```
### service
```sh
$ cat /etc/systemd/system/static-pages.service
[Unit]
Description=Static pages
[Service]
User=debian
ExecStart=/usr/local/bin/static-pages.sh
[Install]
WantedBy=multi-user.target
$ sudo systemctl enable static-pages
```

View file

@ -1,5 +1,5 @@
---
title: 'Forgejo v1.21 documentation'
title: 'Forgejo prerelease documentation'
---
- [What is Forgejo?](/)

View file

@ -22,4 +22,4 @@ licensed under [multiple licenses](https://fontawesome.com/license/free).
Codeberg and the Codeberg Logo are trademarks of Codeberg e.V.
"Knut the Polar Bear" has been derived from https://openclipart.org/detail/193243/polar-bear-remix, under CC0 1.0
"Knut the Polar Bear" has been derived from [Polar bear remix](https://web.archive.org/web/20240318012628if_/https://openclipart.org/detail/193243/polar-bear-remix), under CC0 1.0

View file

@ -6,16 +6,16 @@
"workflow": "",
"run_id": "20",
"run_number": "1",
"actor": "root",
"actor": "forgejo-actions",
"repository": "root/example-cron",
"event_name": "schedule",
"sha": "a61b6b1baff658c1041bcf57f313b04ff60331d7",
"sha": "0412071265e064ae61c8ede383688fe228f85562",
"ref": "main",
"ref_name": "main",
"ref_type": "",
"head_ref": "",
"base_ref": "",
"token": "ea82f423023b55bde6f24c584a3a63576f8acfd7",
"token": "ab87ba96d44ac8a1b9a86e140d2ba9c8582f605c",
"workspace": "/workspace/root/example-cron",
"action": "1",
"action_path": "",
@ -27,7 +27,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -20,8 +20,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -38,7 +38,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -48,20 +48,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -75,6 +75,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -91,23 +92,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92"
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae"
},
"body": "",
"closed_at": null,
"comments": 0,
"created_at": "2024-03-20T14:49:23Z",
"diff_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1.diff",
"created_at": "2024-05-03T07:26:39Z",
"diff_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1.diff",
"due_date": null,
"head": {
"label": "main",
@ -122,8 +123,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/fork-org/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/fork-org/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -140,25 +141,25 @@
"has_pull_requests": true,
"has_releases": false,
"has_wiki": false,
"html_url": "http://10.201.14.201:3000/fork-org/example-pull-request",
"html_url": "http://10.201.14.125:3000/fork-org/example-pull-request",
"id": 15,
"ignore_whitespace_conflicts": false,
"internal": false,
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/fork-org/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/fork-org/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/1bc28d03d2a646081c5f3f2f94128925",
"created": "2024-03-20T14:49:22Z",
"avatar_url": "http://10.201.14.125:3000/avatars/1bc28d03d2a646081c5f3f2f94128925",
"created": "2024-05-03T07:26:38Z",
"description": "",
"email": "",
"followers_count": 0,
@ -172,6 +173,7 @@
"login": "fork-org",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "fork-org",
@ -188,8 +190,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -206,7 +208,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -216,20 +218,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -243,6 +245,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -259,11 +262,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -277,22 +280,22 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:fork-org/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:fork-org/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/fork-org/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/fork-org/example-pull-request",
"watchers_count": 1,
"website": ""
},
"repo_id": 15,
"sha": "739902bec4dc793848c0ca5dc490e671245614b2"
"sha": "f6b554eba3180ac2e5e10c863df13d2a4fe7217a"
},
"html_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1",
"html_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1",
"id": 1,
"is_locked": false,
"labels": [],
"merge_base": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"merge_base": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"merge_commit_sha": null,
"mergeable": true,
"merged": false,
@ -300,19 +303,19 @@
"merged_by": null,
"milestone": null,
"number": 1,
"patch_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1.patch",
"patch_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1.patch",
"pin_order": 0,
"requested_reviewers": null,
"state": "open",
"title": "PR from fork",
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1",
"user": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -324,6 +327,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -341,8 +345,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -359,7 +363,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -369,20 +373,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -396,6 +400,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -412,11 +417,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -425,10 +430,10 @@
"review": null,
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -440,6 +445,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -454,13 +460,13 @@
"actor": "root",
"repository": "root/example-pull-request",
"event_name": "pull_request",
"sha": "739902bec4dc793848c0ca5dc490e671245614b2",
"sha": "f6b554eba3180ac2e5e10c863df13d2a4fe7217a",
"ref": "refs/pull/1/head",
"ref_name": "1",
"ref_type": "",
"head_ref": "main",
"base_ref": "main",
"token": "e9ef4f834b358f3a20cef42d395a7d07e1697f1a",
"token": "56b81ae8f5c555c297f5665fc3163f0d5f1a9b5c",
"workspace": "/workspace/root/example-pull-request",
"action": "6",
"action_path": "",
@ -472,7 +478,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -20,8 +20,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -38,7 +38,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -48,20 +48,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -75,6 +75,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -91,23 +92,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92"
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae"
},
"body": "",
"closed_at": null,
"comments": 0,
"created_at": "2024-03-20T14:49:23Z",
"diff_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1.diff",
"created_at": "2024-05-03T07:26:39Z",
"diff_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1.diff",
"due_date": null,
"head": {
"label": "main",
@ -122,8 +123,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/fork-org/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/fork-org/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -140,25 +141,25 @@
"has_pull_requests": true,
"has_releases": false,
"has_wiki": false,
"html_url": "http://10.201.14.201:3000/fork-org/example-pull-request",
"html_url": "http://10.201.14.125:3000/fork-org/example-pull-request",
"id": 15,
"ignore_whitespace_conflicts": false,
"internal": false,
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/fork-org/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/fork-org/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/1bc28d03d2a646081c5f3f2f94128925",
"created": "2024-03-20T14:49:22Z",
"avatar_url": "http://10.201.14.125:3000/avatars/1bc28d03d2a646081c5f3f2f94128925",
"created": "2024-05-03T07:26:38Z",
"description": "",
"email": "",
"followers_count": 0,
@ -172,6 +173,7 @@
"login": "fork-org",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "fork-org",
@ -188,8 +190,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -206,7 +208,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -216,20 +218,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -243,6 +245,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -259,11 +262,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -277,22 +280,22 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:fork-org/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:fork-org/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/fork-org/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/fork-org/example-pull-request",
"watchers_count": 1,
"website": ""
},
"repo_id": 15,
"sha": "739902bec4dc793848c0ca5dc490e671245614b2"
"sha": "f6b554eba3180ac2e5e10c863df13d2a4fe7217a"
},
"html_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1",
"html_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1",
"id": 1,
"is_locked": false,
"labels": [],
"merge_base": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"merge_base": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"merge_commit_sha": null,
"mergeable": true,
"merged": false,
@ -300,19 +303,19 @@
"merged_by": null,
"milestone": null,
"number": 1,
"patch_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1.patch",
"patch_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1.patch",
"pin_order": 0,
"requested_reviewers": null,
"state": "open",
"title": "PR from fork",
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/root/example-pull-request/pulls/1",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/root/example-pull-request/pulls/1",
"user": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -324,6 +327,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -341,8 +345,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -359,7 +363,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -369,20 +373,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -396,6 +400,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -412,11 +417,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 28,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:22Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:38Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -425,10 +430,10 @@
"review": null,
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -440,6 +445,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -454,13 +460,13 @@
"actor": "root",
"repository": "root/example-pull-request",
"event_name": "pull_request_target",
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"ref": "refs/heads/main",
"ref_name": "main",
"ref_type": "branch",
"head_ref": "main",
"base_ref": "main",
"token": "6fefcc78c1a2afc1d7a8ad4cd27fea3e065c0fd4",
"token": "c0efdade281003d077596e6e356a05d582da3207",
"workspace": "/workspace/root/example-pull-request",
"action": "6",
"action_path": "",
@ -472,7 +478,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -20,8 +20,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -38,7 +38,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -48,20 +48,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -75,6 +75,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -91,23 +92,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92"
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae"
},
"body": "",
"closed_at": null,
"comments": 0,
"created_at": "2024-03-20T14:49:23Z",
"diff_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2.diff",
"created_at": "2024-05-03T07:26:39Z",
"diff_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2.diff",
"due_date": null,
"head": {
"label": "other",
@ -122,8 +123,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -140,7 +141,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -150,20 +151,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -177,6 +178,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -193,23 +195,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "46f117e9893723b589812ffc3627b5106b0db81b"
"sha": "d9c67148a7e8f091909c8393fcfba2246f78b53f"
},
"html_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2",
"html_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2",
"id": 2,
"is_locked": false,
"labels": [],
"merge_base": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"merge_base": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"merge_commit_sha": null,
"mergeable": true,
"merged": false,
@ -217,19 +219,19 @@
"merged_by": null,
"milestone": null,
"number": 2,
"patch_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2.patch",
"patch_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2.patch",
"pin_order": 0,
"requested_reviewers": null,
"state": "open",
"title": "PR same repo",
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2",
"user": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -241,6 +243,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -258,8 +261,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -276,7 +279,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -286,20 +289,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 2,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -313,6 +316,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -329,11 +333,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -342,10 +346,10 @@
"review": null,
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -357,6 +361,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -371,13 +376,13 @@
"actor": "root",
"repository": "root/example-pull-request",
"event_name": "pull_request",
"sha": "46f117e9893723b589812ffc3627b5106b0db81b",
"sha": "d9c67148a7e8f091909c8393fcfba2246f78b53f",
"ref": "refs/pull/2/head",
"ref_name": "2",
"ref_type": "",
"head_ref": "other",
"base_ref": "main",
"token": "eee7081f79fd86a9c8cd7d8dd34c8fffd5f75cab",
"token": "8616dccba92591ababcd087fe5fe6374e2257c46",
"workspace": "/workspace/root/example-pull-request",
"action": "6",
"action_path": "",
@ -389,7 +394,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -20,8 +20,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -38,7 +38,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -48,20 +48,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -75,6 +75,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -91,23 +92,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92"
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae"
},
"body": "",
"closed_at": null,
"comments": 0,
"created_at": "2024-03-20T14:49:23Z",
"diff_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2.diff",
"created_at": "2024-05-03T07:26:39Z",
"diff_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2.diff",
"due_date": null,
"head": {
"label": "other",
@ -122,8 +123,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -140,7 +141,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -150,20 +151,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 1,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -177,6 +178,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -193,23 +195,23 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"repo_id": 14,
"sha": "46f117e9893723b589812ffc3627b5106b0db81b"
"sha": "d9c67148a7e8f091909c8393fcfba2246f78b53f"
},
"html_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2",
"html_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2",
"id": 2,
"is_locked": false,
"labels": [],
"merge_base": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"merge_base": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"merge_commit_sha": null,
"mergeable": true,
"merged": false,
@ -217,19 +219,19 @@
"merged_by": null,
"milestone": null,
"number": 2,
"patch_url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2.patch",
"patch_url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2.patch",
"pin_order": 0,
"requested_reviewers": null,
"state": "open",
"title": "PR same repo",
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/root/example-pull-request/pulls/2",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/root/example-pull-request/pulls/2",
"user": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -241,6 +243,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -258,8 +261,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-pull-request.git",
"created_at": "2024-03-20T14:49:22Z",
"clone_url": "http://10.201.14.125:3000/root/example-pull-request.git",
"created_at": "2024-05-03T07:26:38Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -276,7 +279,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-pull-request",
"html_url": "http://10.201.14.125:3000/root/example-pull-request",
"id": 14,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -286,20 +289,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-pull-request",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 2,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -313,6 +316,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -329,11 +333,11 @@
"release_counter": 0,
"repo_transfer": null,
"size": 29,
"ssh_url": "forgejo@10.201.14.201:root/example-pull-request.git",
"ssh_url": "forgejo@10.201.14.125:root/example-pull-request.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:49:23Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-pull-request",
"updated_at": "2024-05-03T07:26:39Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-pull-request",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
@ -342,10 +346,10 @@
"review": null,
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -357,6 +361,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -371,13 +376,13 @@
"actor": "root",
"repository": "root/example-pull-request",
"event_name": "pull_request_target",
"sha": "69b4e387ae2f39cddace8eb1091f7798b79adf92",
"sha": "08664a8624d2dbe0a88b0d583224c07bcc5007ae",
"ref": "refs/heads/main",
"ref_name": "main",
"ref_type": "branch",
"head_ref": "other",
"base_ref": "main",
"token": "3a1cccaab5ad5a5933df3e6fd44cbb5d482584c5",
"token": "65bc5f5257526adee897d4a05a5da8efed13d53a",
"workspace": "/workspace/root/example-pull-request",
"action": "6",
"action_path": "",
@ -389,7 +394,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -1,6 +1,6 @@
{
"event": {
"after": "a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"after": "10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"before": "0000000000000000000000000000000000000000",
"commits": [
{
@ -17,16 +17,16 @@
"name": "username",
"username": "root"
},
"id": "a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"id": "10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"message": "initial commit\n",
"modified": [],
"removed": [],
"timestamp": "2024-03-20T14:48:32Z",
"url": "http://10.201.14.201:3000/root/example-push/commit/a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"timestamp": "2024-05-03T07:25:52Z",
"url": "http://10.201.14.125:3000/root/example-push/commit/10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"verification": null
}
],
"compare_url": "http://10.201.14.201:3000/",
"compare_url": "http://10.201.14.125:3000/",
"head_commit": {
"added": [
".forgejo/workflows/test.yml"
@ -41,20 +41,20 @@
"name": "username",
"username": "root"
},
"id": "a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"id": "10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"message": "initial commit\n",
"modified": [],
"removed": [],
"timestamp": "2024-03-20T14:48:32Z",
"url": "http://10.201.14.201:3000/root/example-push/commit/a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"timestamp": "2024-05-03T07:25:52Z",
"url": "http://10.201.14.125:3000/root/example-push/commit/10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"verification": null
},
"pusher": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -66,6 +66,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -83,8 +84,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-push.git",
"created_at": "2024-03-20T14:48:32Z",
"clone_url": "http://10.201.14.125:3000/root/example-push.git",
"created_at": "2024-05-03T07:25:52Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -101,7 +102,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-push",
"html_url": "http://10.201.14.125:3000/root/example-push",
"id": 10,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -111,20 +112,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-push/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-push/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-push",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -138,6 +139,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -154,21 +156,21 @@
"release_counter": 0,
"repo_transfer": null,
"size": 25,
"ssh_url": "forgejo@10.201.14.201:root/example-push.git",
"ssh_url": "forgejo@10.201.14.125:root/example-push.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:48:32Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-push",
"updated_at": "2024-05-03T07:25:53Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-push",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -180,6 +182,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -195,13 +198,13 @@
"actor": "root",
"repository": "root/example-push",
"event_name": "push",
"sha": "a1df68fd4f222d745ebf3a78ee63d182338d4bf2",
"sha": "10cf39c7b1bc4ffccafd1dc68e0c98e4042a6d0c",
"ref": "refs/heads/main",
"ref_name": "main",
"ref_type": "branch",
"head_ref": "",
"base_ref": "",
"token": "bf0701d0998ed222c2523b87a800eaf60b254d13",
"token": "ca8a7ad801950850bc2d3ede539cfc2b52b40d90",
"workspace": "/workspace/root/example-push",
"action": "0",
"action_path": "",
@ -213,7 +216,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -1,9 +1,9 @@
{
"event": {
"after": "c5fa6406c732cab23a32815ee5f699ba68a43443",
"after": "8ed35c4bdee3b164a7f9670cc4c20e5d7d09d702",
"before": "0000000000000000000000000000000000000000",
"commits": [],
"compare_url": "http://10.201.14.201:3000/root/example-tag/compare/0000000000000000000000000000000000000000...c5fa6406c732cab23a32815ee5f699ba68a43443",
"compare_url": "http://10.201.14.125:3000/root/example-tag/compare/0000000000000000000000000000000000000000...8ed35c4bdee3b164a7f9670cc4c20e5d7d09d702",
"head_commit": {
"added": [
".forgejo/workflows/test.yml",
@ -19,20 +19,20 @@
"name": "username",
"username": "root"
},
"id": "c5fa6406c732cab23a32815ee5f699ba68a43443",
"id": "8ed35c4bdee3b164a7f9670cc4c20e5d7d09d702",
"message": "initial commit\n",
"modified": [],
"removed": [],
"timestamp": "2024-03-20T14:48:37Z",
"url": "http://10.201.14.201:3000/root/example-tag/commit/c5fa6406c732cab23a32815ee5f699ba68a43443",
"timestamp": "2024-05-03T07:25:58Z",
"url": "http://10.201.14.125:3000/root/example-tag/commit/8ed35c4bdee3b164a7f9670cc4c20e5d7d09d702",
"verification": null
},
"pusher": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -44,6 +44,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -61,8 +62,8 @@
"archived": false,
"archived_at": "1970-01-01T00:00:00Z",
"avatar_url": "",
"clone_url": "http://10.201.14.201:3000/root/example-tag.git",
"created_at": "2024-03-20T14:48:38Z",
"clone_url": "http://10.201.14.125:3000/root/example-tag.git",
"created_at": "2024-05-03T07:25:58Z",
"default_allow_maintainer_edit": false,
"default_branch": "main",
"default_delete_branch_after_merge": false,
@ -79,7 +80,7 @@
"has_pull_requests": true,
"has_releases": true,
"has_wiki": true,
"html_url": "http://10.201.14.201:3000/root/example-tag",
"html_url": "http://10.201.14.125:3000/root/example-tag",
"id": 11,
"ignore_whitespace_conflicts": false,
"internal": false,
@ -89,20 +90,20 @@
"enable_time_tracker": true
},
"language": "",
"languages_url": "http://10.201.14.201:3000/api/v1/repos/root/example-tag/languages",
"languages_url": "http://10.201.14.125:3000/api/v1/repos/root/example-tag/languages",
"link": "",
"mirror": false,
"mirror_interval": "",
"mirror_updated": "0001-01-01T00:00:00Z",
"name": "example-tag",
"object_format_name": "",
"object_format_name": "sha1",
"open_issues_count": 0,
"open_pr_counter": 0,
"original_url": "",
"owner": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@example.com",
"followers_count": 0,
@ -116,6 +117,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -132,21 +134,21 @@
"release_counter": 0,
"repo_transfer": null,
"size": 26,
"ssh_url": "forgejo@10.201.14.201:root/example-tag.git",
"ssh_url": "forgejo@10.201.14.125:root/example-tag.git",
"stars_count": 0,
"template": false,
"updated_at": "2024-03-20T14:48:38Z",
"url": "http://10.201.14.201:3000/api/v1/repos/root/example-tag",
"updated_at": "2024-05-03T07:25:58Z",
"url": "http://10.201.14.125:3000/api/v1/repos/root/example-tag",
"watchers_count": 1,
"website": "",
"wiki_branch": "main"
},
"sender": {
"active": false,
"avatar_url": "http://10.201.14.201:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-03-20T14:45:23Z",
"avatar_url": "http://10.201.14.125:3000/avatars/04edfc0ef6c6cf6d6b88fbc69f9f9071",
"created": "2024-05-03T07:20:44Z",
"description": "",
"email": "root@noreply.10.201.14.201",
"email": "root@noreply.10.201.14.125",
"followers_count": 0,
"following_count": 0,
"full_name": "",
@ -158,6 +160,7 @@
"login": "root",
"login_name": "",
"prohibit_login": false,
"pronouns": "",
"restricted": false,
"starred_repos_count": 0,
"username": "root",
@ -173,13 +176,13 @@
"actor": "root",
"repository": "root/example-tag",
"event_name": "push",
"sha": "c5fa6406c732cab23a32815ee5f699ba68a43443",
"sha": "8ed35c4bdee3b164a7f9670cc4c20e5d7d09d702",
"ref": "refs/tags/v1.1",
"ref_name": "v1.1",
"ref_type": "tag",
"head_ref": "",
"base_ref": "",
"token": "1a141a578c7d3e896321369ccbcf74883fb3d58e",
"token": "c52d9ad082448d478a896f03cc9407075925eec3",
"workspace": "/workspace/root/example-tag",
"action": "0",
"action_path": "",
@ -191,7 +194,7 @@
"retention_days": "",
"runner_perflog": "/dev/null",
"runner_tracking_id": "",
"server_url": "http://10.201.14.201:3000",
"api_url": "http://10.201.14.201:3000/api/v1",
"server_url": "http://10.201.14.125:3000",
"api_url": "http://10.201.14.125:3000/api/v1",
"graphql_url": ""
}

View file

@ -1 +1 @@
7.0-test
7.0.2

View file

@ -1,7 +1,7 @@
---
title: 'Forgejo Actions user guide'
license: 'CC-BY-SA-4.0'
similar: 'https://github.com/go-gitea/gitea/blob/main/docs/content/doc/usage/actions/faq.en-us.md https://docs.github.com/en/actions'
similar: 'https://github.com/go-gitea/gitea/blob/main/docs/content/usage/actions/faq.en-us.md https://docs.github.com/en/actions'
---
`Forgejo Actions` provides Continuous Integration driven from the files in the `.forgejo/workflows` directory of a repository, with a web interface to show the results. The syntax and semantics of the `workflow` files will be familiar to people used to [GitHub Actions](https://docs.github.com/en/actions) but **they are not and will never be identical**.
@ -27,6 +27,13 @@ The following guide explains key **concepts** to help understand how `workflows`
- Click on the workflow link to see the details and the job execution logs.
![actions results](../_images/user/actions/workflow-demo.png)
## Hierarchy
In Forgejo terminology a `workflow` is a `.yml` file in the
`.forgejo/workflows` directory of the repository. A `workflow` has `jobs` with
`steps` to be executed by a Action runner. See the [Glossary](#glossary) for
more descriptions of key terms.
## Actions
An `Action` is a repository that contains the equivalent of a function in any programming language. It comes in two flavors, depending on the file found at the root of the repository:
@ -159,17 +166,20 @@ by using the https://code.forgejo.org/actions/cache action.
There is no guarantee that the cache is populated, even when two `jobs`
run in sequence. It is not a substitute for `artifacts`.
Note that [actions/cache](https://code.forgejo.org/actions/cache) has `zstd`
as a dependency for creating tar archives in the runner.
See also the [set of examples](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-cache/.forgejo/workflows/).
## Auto cancelation of workflows
> **NOTE:** [actions/cache](https://code.forgejo.org/actions/cache) will us `zstd` if present when compressing files to be sent to the cache. It is faster than the default compression.
> **NOTE:** if the runner is not configured to provide a cache, [actions/cache](https://code.forgejo.org/actions/cache) will fail with the following error: `Cache action is only supported on GHES version >= 3.5`.
## Auto cancellation of workflows
When a new commit is pushed to a branch, the workflows that are were
triggered by parent commits are canceled.
## Services
PostgreSQL, redis and other services can be run from container images with something similar to the following. See also the [set of examples](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-service/.forgejo/workflows/).
PostgreSQL, Redis and other services can be run from container images with something similar to the following. See also the [set of examples](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-service/.forgejo/workflows/).
```yaml
services:
@ -200,7 +210,7 @@ A list of command and arguments, equivalent to [[COMMAND] [ARG...]](https://docs
A string of additional options, as documented [docker run](https://docs.docker.com/engine/reference/commandline/run/). For instance: "--workdir /myworkdir --ulimit nofile=1024:1024".
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
> **NOTE:** the `--volume` option is restricted to a allowlist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
### username
@ -315,13 +325,13 @@ A context is an object that contains information relevant to a `workflow` run. F
### secrets
A map of the respository secrets. It is empty if the `event` that triggered the `workflow` is `pull_request` and the head is from a fork of the repository.
A map of the repository secrets. It is empty if the `event` that triggered the `workflow` is `pull_request` and the head is from a fork of the repository.
Example: `${{ secrets.MYSECRETS }}`
### vars
A map of the respository variables.
A map of the repository variables.
Example: `${{ vars.MYVARIABLE }}`
@ -640,7 +650,7 @@ jobs:
runs-on: docker
```
means that the `Forgejo runner` that claims to provide a kind of machine labelled `docker` will be selected by `Forgejo` and sent the job to be run.
means that the `Forgejo runner` that claims to provide a kind of machine labeled `docker` will be selected by `Forgejo` and sent the job to be run.
The actual machine provided by the runner **entirely depends on how the `Forgejo runner` was registered** (see the [Forgejo Actions administrator guide](../../admin/actions/) for more information).
@ -669,8 +679,8 @@ jobs:
runs-on: self-hosted
strategy:
matrix:
variant: ["bookworm", "bullseye"]
node: ["18", "20"]
variant: ['bookworm', 'bullseye']
node: ['18', '20']
```
Will create four jobs where:
@ -697,7 +707,7 @@ steps:
### `jobs.<job_id>.container.image`
- **Docker or Podman:**
If the default image is unsuitable, a job can specify an alternate container image with `container:`, [as shown in this example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-container/.forgejo/workflows/test.yml). For instance the following will ensure the job is run using [Alpine 3.18](https://hub.docker.com/_/alpine/tags?name=3.18).
If the default image is unsuitable, a job can specify an alternate container image with `container:`, [as shown in this example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-container/.forgejo/workflows/test.yml). If not specified, the shell defaults to `sh`. For instance the following will ensure the job is run using [Alpine 3.18](https://hub.docker.com/_/alpine/tags?name=3.18).
```yaml
runs-on: docker
@ -742,7 +752,7 @@ container:
Set the volumes for the container to use, as if provided with the `--volume` argument of the `docker run` command.
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
> **NOTE:** the `--volume` option is restricted to a allowlist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
> **NOTE:** ignored if `jobs.<job_id>.runs-on` is an LXC container.
@ -752,7 +762,7 @@ Set the volumes for the container to use, as if provided with the `--volume` arg
A string of additional options, as documented in [docker run](https://docs.docker.com/engine/reference/commandline/run/). For instance: "--workdir /myworkdir --ulimit nofile=1024:1024".
> **NOTE:** the `--volume` option is restricted to a whitelist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
> **NOTE:** the `--volume` option is restricted to a allowlist of volumes configured in the runner executing the task. See the [Forgejo Actions administrator guide](../../admin/actions/) for more information.
> **NOTE:** ignored if `jobs.<job_id>.runs-on` is an LXC container.
@ -818,7 +828,7 @@ jobs:
steps:
- run: |
grep Alpine /etc/os-release
echo SUCESS
echo SUCCESS
```
[Check out the example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-container/.forgejo/workflows/test.yml)
@ -834,12 +844,41 @@ The working directory from which the script specified with `jobs.<job_id>.step[*
### `jobs.<job_id>.steps[*].shell`
The shell used to run the script specified with `jobs.<job_id>.step[*].run`. For instance:
The shell used to run the script specified with `jobs.<job_id>.step[*].run`. If not specified it defaults to `bash`.
For instance:
```yaml
steps:
- shell: bash
run: echo $PATH
jobs:
test:
runs-on: docker
steps:
- run: echo using bash here
```
Or to specify that `sh` must be used instead:
```yaml
jobs:
test:
runs-on: docker
steps:
- shell: sh
run: echo using sh here
```
If `jobs.<job_id>.container.image` is set and the shell is not specified, it defaults to `sh`.
For instance:
```yaml
jobs:
test:
runs-on: docker
container:
image: alpine:3.20
steps:
- run: echo using sh here
```
[Check out the example](https://code.forgejo.org/forgejo/end-to-end/src/branch/main/actions/example-pull-request/.forgejo/workflows/test.yml)
@ -1031,13 +1070,14 @@ test "KEY2=$KEY2" = "KEY2=value2"
## Glossary
- **action:** a repository that can be used in a way similar to a function in any programming language to run a single **step**.
- **artifact** is a file or collection of files produced during a **workflow** run.
- **automatic token** is the token created at the begining of each **workflow**.
- **context** is a top level object available in an expression that contains information about the running workflow.
- **artifact:** a file or collection of files produced during a **workflow** **run**.
- **automatic token:** the unique token created during each **run** by the **runner**.
- **context:** top level objects containing the current state of a **run** containing information about the **workflow** and the **runner** handling the **job**.
- **expression:** a string enclosed in `${{ ... }}` and evaluated at runtime.
- **job:** a sequential set of **steps**.
- **label** the kind of machine that is matched against the value of `runs-on` in a **workflow**.
- **runner:** the [Forgejo runner](https://code.forgejo.org/forgejo/runner) daemon tasked to execute the **workflows**.
- **label:** the kind of machine that is matched against the value of `runs-on` in a **workflow**.
- **run:** the execution of a **job**.
- **runner:** the [Forgejo runner](https://code.forgejo.org/forgejo/runner) daemon created to execute the **workflows**.
- **step:** a command the **runner** is required to carry out.
- **workflow or task:** a file in the `.forgejo/workflows` directory that contains **jobs**.
- **workspace** is the directory where the files of the **job** are stored and shared between all **step**s.
- **workflow:** a file in the `.forgejo/workflows` directory containing **jobs**.
- **workspace:** the directory where the files of the **job** are stored and shared between all **step**s.

View file

@ -1,7 +1,7 @@
---
title: 'AGit Workflow Usage'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/agit-support.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/agit-support.en-us.md'
---
Forgejo ships with limited support for [AGit-Flow](https://git-repo.info/en/2020/03/agit-flow-and-git-repo/). It was originally introduced in Gitea `1.13`.
@ -45,6 +45,24 @@ This can be **any** markdown content.\n
- [x] Ok"
```
To be able to easily push new commits to your pull request, you first need to switch the [default push method](https://git-scm.com/docs/git-config#Documentation/git-config.txt-pushdefault) to "upstream":
```shell
# To only set this option for this specific repository
git config push.default upstream
# Or run this instead if you want to set this option globally
git config --global push.default upstream
```
Then, run the following command:
```shell
git config branch.local-branch.merge refs/for/main/topic-branch
```
After doing so, you can now simply run `git push` to push commits to your pull request, without having to specify the refspec.
This also will allow you to pull, fetch, rebase, etc. from the AGit pull request by default.
#### A More Complex Example
Suppose that the currently checked out branch in your local repository is `main`, yet you would like to submit a Pull Request meant for a remote branch called `remote-branch`.

View file

@ -1,7 +1,7 @@
---
title: 'API Usage'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/development/api-usage.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/development/api-usage.en-us.md'
---
The Forgejo API for all versions that have the same major number
@ -9,7 +9,7 @@ The Forgejo API for all versions that have the same major number
are breaking changes (e.g. removal of an API endpoint) when the major
number changes and the release notes of this major version provide
explanations to help developers upgrade their software
accordingly. Read more about the [Forgejo numbering scheme](./versions/).
accordingly. Read more about the [Forgejo numbering scheme](../versions/).
## Enabling/configuring API access

View file

@ -1,7 +1,7 @@
---
title: 'Authentication'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/authentication.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/authentication.en-us.md'
---
## LDAP (Lightweight Directory Access Protocol)

View file

@ -1,7 +1,7 @@
---
title: 'Blame File View'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/blame.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/blame.en-us.md'
---
Forgejo supports viewing the line-by-line revision history for a file also known as blame view.

View file

@ -7,10 +7,18 @@ Forgejo supports code search through an indexer and `git-grep` as a fallback whe
# Basic (git-grep)
![Code search results page using git-grep](../_images/user/code-search/gitgrep.png)
If `REPO_INDEXER_ENABLED` is set to `false`, the code search function will be limited to a single repository and will use [`git-grep`](https://git-scm.com/docs/git-grep).
Currently, only fixed strings are supported and any case differences are ignored. The search results will include the matched line, along with a context of three lines before and after the match. The search query will be executed on the default branch of the repository.
Currently, only fixed strings are supported and any case differences are ignored. The search results will include the matched line, along with a single line before and after the match.
Since, the searches are performed in the fly they may be performed on any valid branch or tag.
# Indexer
![Code search results page using indexer](../_images/user/code-search/indexer.png)
For advanced search queries and searching across an entire organisation or instance, `REPO_INDEXER_ENABLED: true` enables code search via bleve/elasticsearch.
However, search results are limited to the HEAD of the repository.

View file

@ -27,7 +27,7 @@ In the section “Manage Email Addresses”, you can select one of the following
When you're finished, press the button “Set Email Preference” to confirm your selection.
> **Note:**
> Disabling email notifications doesn't mean that you'll stop receiving important messages from the Forgejo organisation.
> Disabling email notifications doesn't mean that you'll stop receiving important messages from the Forgejo organization.
## Issue notifications

View file

@ -24,31 +24,32 @@ Here's an explanation of the form's fields:
- **Owner** Here, you can specify whether you want this to be your own personal project or whether you want it to be part of an organization that you're a part of
- **Repository name** A name for your repository (which will also be part of its path, in this case `https://codeberg.org/knut/foobar`)
- **Visibility** Repositories are either _public_ or _private_, where public means that everyone will be able to access your repository, while your private repositories can only be accessed by you and your collaborators (see [Invite Collaborators](../invite-collaborators))
- **Visibility** Repositories are either _public_ or _private_, where public means that everyone will be able to access your repository, while your private repositories can only be accessed by you and your collaborators (see [Invite Collaborators](https://docs.codeberg.org/collaborating/invite-collaborators/))
- **Description** A short description that appears next to your repository's name where appropriate
- **Template** Occasionally you may want to generate your repository from an existing template. In that case, you can specify that template here. Otherwise, simply leave this field empty.
- **Issue Labels** If you want to initialize your project's issue tracker with a set of labels that you can use to categorize issues, you can choose one here. You don't have to choose this right away though, as you can choose and modify issue labels at a later time as well.
- **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of. This is useful, for example to prevent configuration files or binaries to be tracked in version control. You can choose to add a pre-defined file matching the programming language you use now, or add one manually later.
- **.gitignore** A [.gitignore](https://git-scm.com/docs/gitignore) file defines which files Git should not keep track of. This is useful, for example to prevent configuration files or binaries to be tracked in version control. You can choose to add a predefined file matching the programming language you use now, or add one manually later.
- **License** Here, you can choose from a list of FSF/OSI approved licenses. A `LICENSE` file will then be added to the repository. For some help on choosing the correct license, have a look at our [licensing article](/getting-started/licensing/).
- **README** is the first file one should read when accessing a repository. It's also the first file displayed when accessing a repository, a bit like the "homepage" of your repository. On Forgejo, this is interpreted as a [Markdown](/markdown/) file.
- **Initialize repository** In order to add the `LICENSE`, `README` and `.gitignore` files mentioned above to your new repository, make sure you tick this box.
- **Default branch** Using this field, you can choose how to name the default branch of your Git repository. We recommend you use the predefined default.
- **Object format** is the repository's object format. We recommend SHA1 as it's the most compatible. It cannot be changed later once the repository has been created.
It's okay to only specify owner and repository name, if you want to get started quickly.
After filling out the fields, click the green "Create Repository" button on the bottom of the page.
You should now see a screen similar to the one below. If you haven't chosen to generate `LICENSE`, `README` and `.gitignore` the screen might show instructions instead, which will vanish after [your first commit](#making-your-first-commit/).
![screenshot showing a freshly baken repository](../_images/user/first-repository/create-repo-3.png)
![screenshot showing a freshly baked repository](../_images/user/first-repository/create-repo-3.png)
Here's what the most important buttons do:
- **Repository Settings (1)** is where you can make adjustments to your repository settings, such as setting a project website, changing the repository description, enabling/disabling a wiki and issue tracker or deleting the repository. You may want to give this page a visit right now, to get an overview of your options.
- **The Watch, Star and Fork buttons (2)** allow you to interact with other people's repositories. While they don't do much for your own repository, when visiting another user's repository, you can click on "Watch" to get notified about everything important happening in that repository, "Star" to show the user your appreciation (and to help other users find interesting projects more quickly) and "Fork" to create your own copy of the repository, for example to make modifications that you want to share with the original author.
- **The Repository Tabs (3)** contain links to every important feature within this repository:
- **The RSS, Watch, Star and Fork buttons (2)** allow you to interact with other people's repositories. While they don't do much for your own repository, when visiting another user's repository, you can click on "Watch" to get notified about everything important happening in that repository, "Star" to show the user your appreciation (and to help other users find interesting projects more quickly) and "Fork" to create your own copy of the repository, for example to make modifications that you want to share with the original author. You can also use the RSS button to get the RSS feed of the repository.
- **The Repository Tabs (3)** contain links to every important feature within this repository (some may not be visible by default):
- **Code** lets you browse through all versions of this repository's code.
- **Issues** is a very important communication tool between the author, their users and their contributors. Think of it as part bug-tracker, part forum.
For more information on this, have a look at [The Basics of Issue Tracking](/getting-started/issue-tracking-basics/)
For more information on this, have a look at [The Basics of Issue Tracking](../issue-tracking-basics/)
- **Pull Requests** is where other users can ask the author to "pull" in code, from a fork into the author's program.
- **Releases** is a space where the author can upload finished versions of their program, e.g. binaries
- **Wiki** is a basic wiki feature built into Forgejo.
@ -135,7 +136,7 @@ When you clone a repository from the Internet, the URL that you got your copy of
If your local copy of the repository is missing some commits that exist in the remote repository, pushing will result in an error. There are two ways to fix this:
- Run `git pull` to combine your local changes with the changes that exist in the remote repository. If this does not work, please follow the instructions in your terminal.
- If you know what you are doing, you can also overwrite the remote repository uaing `git -f push`.
- If you know what you are doing, you can also overwrite the remote repository using `git -f push`.
This action will **permanently** alter your remote repository and is not suitable if you are working on a project together with other people.
## Making your first commit

View file

@ -11,4 +11,4 @@ bugs, or even casually host a project.
Please make sure you have a mirror or backup of any important data uploaded
to Forgejo Next! It won't be reset unless there is a need to, but this instance is
running potentially unstable code, so don't use it as your only storage for
irreplacable valuable data.
irreplaceable valuable data.

18
docs/user/incoming.md Normal file
View file

@ -0,0 +1,18 @@
---
title: Comment on issues and pull requests via email
license: 'CC-BY-SA-4.0'
---
> **NOTE:** this feature is not enabled by default, the [`[email.incoming].ENABLED`](../../admin/config-cheat-sheet/) setting must be set.
When receiving a notification it is possible to reply to the email instead of using the web interface. The content of the reply will be stripped of the quoted text (lines starting with greater than `>`) and used as the content of the comment. The attachments from the reply will be added as attachments to the comment.
It will be taken into account when receiving a notification email about:
- A newly created issue
- A newly created pull request
- A comment added to a specific line of code in a pull request review
- A comment to an existing issue
- A comment to an existing pull request
> **NOTE:** the reply address contains a unique token to match the response with the issue or pull request and looks like this: `forgejo+ABCDE@example.com`. In some mail clients, such as Thunderbird, using this reply address may require using the `Reply List` button rather than the `Reply` button.

View file

@ -32,6 +32,7 @@ involved in running it on their machines.
- [README badges](./readme-badges/)
- Advanced Usage
- [Issue and Pull Request Templates](./issue-pull-request-templates/)
- [Comment on issues and pull requests via email](./incoming/)
- [Actions](./actions/)
- [Merge Message templates](./merge-message-templates/)
- [Webhooks](./webhooks/)
@ -47,6 +48,7 @@ involved in running it on their machines.
- [Forgejo versions](./versions/)
- [Reference](https://codeberg.org/api/swagger)
- [Migrating Repositories](https://docs.codeberg.org/advanced/migrating-repos/)
- [Repository Mirrors](./repo-mirror/)
- [Push to create](./push-to-create/)
- [AGit Workflow Usage](./agit-support/)
- [Packages](./packages/)

View file

@ -1,7 +1,7 @@
---
title: 'Issue and Pull Request Templates'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/issue-pull-request-templates.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/issue-pull-request-templates.en-us.md'
---
Some projects have a standard list of questions that users need to answer
@ -9,9 +9,30 @@ when creating an issue or pull request. Forgejo supports adding templates to the
**default branch of the repository** so that they can autopopulate the form when users are
creating issues and pull requests. This will cut down on the initial back and forth
of getting some clarifying details.
It is currently not possible to provide generic issue/pull-request templates globally.
Additionally, the New Issue page URL can be suffixed with `?title=Issue+Title&body=Issue+Text` and the form will be populated with those strings. Those strings will be used instead of the template if there is one.
## Directory names
Users can create multiple issue templates inside a special directory and allow users to choose one that more specifically
addresses their problem.
Forgejo will look for template files in the following directories:
- `ISSUE_TEMPLATE`
- `issue_template`
- `.forgejo/ISSUE_TEMPLATE`
- `.forgejo/issue_template`
- `.gitea/ISSUE_TEMPLATE`
- `.gitea/issue_template`
- `.github/ISSUE_TEMPLATE`
- `.github/issue_template`
- `.gitlab/ISSUE_TEMPLATE`
- `.gitlab/issue_template`
Inside the directory can be multiple markdown (`.md`) or yaml (`.yaml`/`.yml`) issue templates of the form.
## File names
Possible file names for issue templates:
@ -22,29 +43,11 @@ Possible file names for issue templates:
- `issue_template.md`
- `issue_template.yaml`
- `issue_template.yml`
- `.gitea/ISSUE_TEMPLATE.md`
- `.gitea/ISSUE_TEMPLATE.yaml`
- `.gitea/ISSUE_TEMPLATE.yml`
- `.gitea/issue_template.md`
- `.gitea/issue_template.yaml`
- `.gitea/issue_template.yml`
- `.github/ISSUE_TEMPLATE.md`
- `.github/ISSUE_TEMPLATE.yaml`
- `.github/ISSUE_TEMPLATE.yml`
- `.github/issue_template.md`
- `.github/issue_template.yaml`
- `.github/issue_template.yml`
Possible file names for issue config:
- `.gitea/ISSUE_TEMPLATE/config.yaml`
- `.gitea/ISSUE_TEMPLATE/config.yml`
- `.gitea/issue_template/config.yaml`
- `.gitea/issue_template/config.yml`
- `.github/ISSUE_TEMPLATE/config.yaml`
- `.github/ISSUE_TEMPLATE/config.yml`
- `.github/issue_template/config.yaml`
- `.github/issue_template/config.yml`
- `config.yaml`
- `config.yml`
Possible file names for PR templates:
@ -54,36 +57,6 @@ Possible file names for PR templates:
- `pull_request_template.md`
- `pull_request_template.yaml`
- `pull_request_template.yml`
- `.gitea/PULL_REQUEST_TEMPLATE.md`
- `.gitea/PULL_REQUEST_TEMPLATE.yaml`
- `.gitea/PULL_REQUEST_TEMPLATE.yml`
- `.gitea/pull_request_template.md`
- `.gitea/pull_request_template.yaml`
- `.gitea/pull_request_template.yml`
- `.github/PULL_REQUEST_TEMPLATE.md`
- `.github/PULL_REQUEST_TEMPLATE.yaml`
- `.github/PULL_REQUEST_TEMPLATE.yml`
- `.github/pull_request_template.md`
- `.github/pull_request_template.yaml`
- `.github/pull_request_template.yml`
## Directory names
Alternatively, users can create multiple issue templates inside a special directory and allow users to choose one that more specifically
addresses their problem.
Possible directory names for issue templates:
- `ISSUE_TEMPLATE`
- `issue_template`
- `.gitea/ISSUE_TEMPLATE`
- `.gitea/issue_template`
- `.github/ISSUE_TEMPLATE`
- `.github/issue_template`
- `.gitlab/ISSUE_TEMPLATE`
- `.gitlab/issue_template`
Inside the directory can be multiple markdown (`.md`) or yaml (`.yaml`/`.yml`) issue templates of the form.
## Syntax for markdown template
@ -114,11 +87,21 @@ This example YAML configuration file defines an issue form using several inputs
name: Bug Report
about: File a bug report
title: '[Bug]: '
ref: 'main'
labels:
- bug
- 'help needed'
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
# some markdown that will only be visible once the issue has been created
- type: markdown
attributes:
value: |
This issue was created by an issue **template** :)
visible: [content]
- type: input
id: contact
attributes:
@ -170,11 +153,16 @@ body:
options:
- label: I agree to follow this project's Code of Conduct
required: true
- label: I have also read the CONTRIBUTION.MD
required: true
visible: [form]
- label: This is a TODO only visible after issue creation
visible: [content]
```
### Markdown
You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted.
You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted by default.
Attributes:
@ -182,6 +170,8 @@ Attributes:
| ----- | ------------------------------------------------------------ | -------- | ------ | ------- | ------------ |
| value | The text that is rendered. Markdown formatting is supported. | Required | String | - | - |
visible: Default is **[form]**
### Textarea
You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields.
@ -202,6 +192,8 @@ Validations:
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
visible: Default is **[form, content]**
### Input
You can use an `input` element to add a single-line text field to your form.
@ -217,11 +209,13 @@ Attributes:
Validations:
| Key | Description | Required | Type | Default | Valid values |
| --------- | ----------------------------------------------------------------------------------------- | -------- | ------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| required | Prevents form submission if the input is empty. | Optional | Boolean | false | - |
| is_number | Prevents form submission if the value of the input is not a number. | Optional | Boolean | false | - |
| regex | Prevents form submission if the value of the input does not match the regular expression. | Optional | String | - | a [JavaScript regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) |
| Key | Description | Required | Type | Default | Valid values |
| --------- | ------------------------------------------------------------------------------------------------ | -------- | ------- | ------- | ------------------------------------------------------------------------ |
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
| is_number | Prevents form submission until element is filled with a number. | Optional | Boolean | false | - |
| regex | Prevents form submission until element is filled with a value that match the regular expression. | Optional | String | - | a [regular expression](https://en.wikipedia.org/wiki/Regular_expression) |
visible: Default is **[form, content]**
### Dropdown
@ -242,6 +236,8 @@ Validations:
| -------- | ---------------------------------------------------- | -------- | ------- | ------- | ------------ |
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
visible: Default is **[form, content]**
### Checkboxes
You can use the `checkboxes` element to add a set of checkboxes to your form.
@ -256,10 +252,13 @@ Attributes:
For each value in the options array, you can set the following keys.
| Key | Description | Required | Type | Default | Options |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | ------- | ------- |
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
| Key | Description | Required | Type | Default | Options |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------------ | ------- | ------- |
| label | The identifier for the option, which is displayed in the form. Markdown is supported for bold or italic text formatting, and hyperlinks. | Required | String | - | - |
| required | Prevents form submission until element is completed. | Optional | Boolean | false | - |
| visible | Whether a specific checkbox appears in the form only, in the created issue only, or both. Valid options are "form" and "content". | Optional | String array | false | - |
visible: Default is **[form, content]**
## Syntax for issue config

View file

@ -24,7 +24,7 @@ You can switch between issues that are still open, and those that are already re
Some projects define milestones **(4)**, to which issues can be assigned. They are good for
visualizing the progress of a project's development.
You can create an issue by clicking on the green "New Issue" button **(5)** at the top left
You can create an issue by clicking on the orange "New Issue" button **(5)** at the top right
of the issues list.
Issues in the issue tracker are public, and everyone is able to read and answer them.

View file

@ -1,7 +1,7 @@
---
title: 'Labels'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/labels.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/labels.en-us.md'
---
You can use labels to classify issues and pull requests and to improve your overview over them.

View file

@ -32,13 +32,13 @@ While some of the categories are rather straightforward, a little explanation ab
**Dotfiles** are files whose name starts with a dot, which by convention, suggests they should be hidden, and as such, they are excluded from language statistics.
**Programming languages** and **Markup languages** are more or less self explanatory. The former category includes languages like C, Go, Rust, JavaScript, and many, many others. Markup languages are CSS, HTML, Jinja templates, Jupyter Notebooks, and numeruous other formats.
**Programming languages** and **Markup languages** are more or less self explanatory. The former category includes languages like C, Go, Rust, JavaScript, and many, many others. Markup languages are CSS, HTML, Jinja templates, Jupyter Notebooks, and numerous other formats.
Please consult the [enry][enry] or [linguist][linguist] documentation for more details.
## Adjusting the language detection
Sometimes the programming language of a file is not recognized properly, or it is miscategorized. Forgejo provides a mechanism where the language detection can be told about the language of a file, and its category can be adjusted aswell. The same mechanism can also force a file to be considered for language statistics, regardless of its category - or the opposite, too: to tell Forgejo never to consider it.
Sometimes the programming language of a file is not recognized properly, or it is miscategorized. Forgejo provides a mechanism where the language detection can be told about the language of a file, and its category can be adjusted as well. The same mechanism can also force a file to be considered for language statistics, regardless of its category - or the opposite, too: to tell Forgejo never to consider it.
The way to do this is via a [`.gitattributes`][gitattributes] file. This file has a simple syntax where each line is made up of a pattern, followed by a space separated list of attributes. There are many attributes that git itself supports, but we're only going to talk about the custom attributes for language detection. All of these have a `linguist-` prefix, as that is where they originate from.

View file

@ -1,7 +1,7 @@
---
title: 'Automatically Linked References in Issues, Pull Requests and Commit Messages'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/linked-references.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/linked-references.en-us.md'
---
When an issue, pull request or comment is posted, the text description is parsed
@ -65,7 +65,7 @@ Example:
There are some restrictions in place:
- Code linked in private repositories will not be displayed if the current viewer has insufficent permissions.
- Code linked in private repositories will not be displayed if the current viewer has insufficient permissions.
- It can only ever be a permalink; means linking to files by a branch or tag will not result in a preview.
- There is a maximum amount of lines that will be rendered. By default this is 50.
- Only permalinks to the current instance will work.

View file

@ -1,7 +1,7 @@
---
title: 'Merge Message templates'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/merge-message-templates.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/merge-message-templates.en-us.md'
---
## File names
@ -37,4 +37,4 @@ You can use the following variables enclosed in `${}` inside these templates whi
When rebasing without a merge commit, `REBASE_TEMPLATE.md` modifies the message of the last commit. The following additional variables are available in this template:
- CommitTitle: Commit's title
- CommitBody: Commits's body text
- CommitBody: Commit's body text

View file

@ -1,11 +1,17 @@
---
title: 'OAuth2 provider'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/development/oauth2-provider.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/development/oauth2-provider.en-us.md'
---
Forgejo supports acting as an OAuth2 provider to allow third party applications to access its resources with the user's consent.
> **NOTE:** scoped tokens or personal access tokens are entirely different from OAuth2, see the [Access Token scope](../token-scope/) section for more information.
Forgejo can act as an instance wide OAuth2 provider. To achieve that, OAuth2 applications must be created in the `/admin/applications` page.
> **NOTE:** Third party applications obtaining a token for a user via such an application will have administrative rights. OAuth2 scopes are not yet implemented.
## Endpoints
| Endpoint | URL |
@ -25,10 +31,6 @@ At the moment Forgejo only supports the [**Authorization Code Grant**](https://t
To use the Authorization Code Grant as a third party application it is required to register a new application via the "Settings" (`/user/settings/applications`) section of the settings. To test or debug you can use the web-tool https://oauthdebugger.com/.
## Scoped Tokens
See the [Access Token scope](../token-scope/) section for more information.
## Client types
Forgejo supports both confidential and public client types, [as defined by RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749#section-2.1).
@ -66,14 +68,53 @@ to authenticate on https://code.forgejo.org:
- `git clone https://code.forgejo.org/earl-warren/test`
- `git push` will open new page on the default browser, looking like this:
![git-credential-oauth OAuth2 grant page](../_images/user/oauth2-provider/oauth-git-credential-client.png)
- subsequent `git push` will re-use the token obtained from OAuth2 as long as it remains in the [git credential-cache](https://git-scm.com/docs/git-credential-cache) (i.e. 2h / 7200s)
- subsequent `git push` will reuse the token obtained from OAuth2 as long as it remains in the [git credential-cache](https://git-scm.com/docs/git-credential-cache) (i.e. 2h / 7200s)
> **NOTE:** Scopes are not implemented for OAuth2 tokens and they can be used to execute any actions on behalf the user, not just git related actions. Scoped applications tokens or SSH keys limited to interactions with the repository should be prefered in environments where security is a concern.
> **NOTE:** Scopes are not implemented for OAuth2 tokens and they can be used to execute any actions on behalf the user, not just git related actions. Scoped applications tokens or SSH keys limited to interactions with the repository should be preferred in environments where security is a concern.
It is possible for any user to manually register a new OAuth2 application in the `/user/settings/applications` page for the purpose of using a Git [credential helpers](https://git-scm.com/docs/gitcredentials#_custom_helpers) different from the pre-registered ones. In that case the `~/gitconfig` setting (`oauthClientId` etc.) needs to be adapted accrodingly
It is possible for any user to manually register a new OAuth2 application in the `/user/settings/applications` page for the purpose of using a Git [credential helpers](https://git-scm.com/docs/gitcredentials#_custom_helpers) different from the pre-registered ones. In that case the `~/gitconfig` setting (`oauthClientId` etc.) needs to be adapted accordingly
## Examples
### Using a Codeberg as an authentication source
In this example https://v7.next.forgejo.org will be configured to add the option to delegate user registration to https://codeberg.org.
![Login page with Codeberg authentication source](../_images/user/oauth2-provider/authsource-intro-login-page.png)
> **NOTE:** in the OAuth2 jargon, https://v7.next.forgejo.org is the OAuth2 client and Codeberg is the OAuth2 provider
- Choose an arbitrary but distinctive name for the OAuth2 provider: (e.g. **Codeberg**).
- Choose an existing Codeberg user to create the OAuth2 application. It does not need to be a user with elevated privileges. (e.g. **user-for-oauth-application**)
- On https://codeberg.org, login as **user-for-oauth-application**
- Visit https://codeberg.org/user/settings/applications and create a new OAuth2 application. There needs to be only one redirect URI, composed with the abitrary name that was chosen above: https://v7.next.forgejo.org/user/oauth2/Codeberg/callback.
![Create a new OAuth2 application](../_images/user/oauth2-provider/authsource-provider-create.png)
- When created, the OAuth2 application is given a **Client ID** and a **Client secret** that https://v7.next.forgejo.org will need to let https://codeberg.org know it is an authorized OAuth2 client.
![Client ID and secret of a new OAuth2 application](../_images/user/oauth2-provider/authsource-provider-show.png)
- On https://v7.next.forgejo.org, login as a user with admin privileges
- Create a new authentication source on https://v7.next.forgejo.org, the Forgejo instance that is going to act as the OAuth2 client, allowing its users to register using the account they have on https://codeberg.org.
- Visit https://v7.next.forgejo.org/admin/auths/new to create the authentication source with:
- **Authentication type:** OAuth2
- **Authentication name:** the abitrary name that was chosen above (e.g. **Codeberg**)
- **OAuth2 provider:** OpenID Connect
- **Client ID:** copy/pasted from the OAuth2 application created on Codebeg
- **Client Secret:** copy/pasted from the OAuth2 application created on Codebeg
- **Icon URL:** https://design.codeberg.org/logo-kit/icon.svg
- **OpenID Connect Auto Discovery URL:** https://codeberg.org/.well-known/openid-configuration
- Leave all other fields to their default values
![Create a new OAuth2 authentication soure](../_images/user/oauth2-provider/authsource-client-create.png)
- It will show in the list of authentication sources at https://v7.next.forgejo.org/admin/auths.
![List of OAuth2 authentication soure](../_images/user/oauth2-provider/authsource-client-list.png)
- On https://v7.next.forgejo.org, not logged in
- Visit https://v7.next.forgejo.org/user/login
![Login page with Codeberg authentication source](../_images/user/oauth2-provider/authsource-intro-login-page.png)
- Click on **Sign in with Codeberg** to be redirected to Codeberg and authorize https://v7.next.forgejo.org to obtain the details of your account (user name, email, etc.). If you are not already logged in Codeberg, you will need to before this authorization request is presented to you.
![Authorizing v7.next.forgejo.org](../_images/user/oauth2-provider/authsource-intro-login-confirm.png)
- Review the pre-filled information that will be used to create your account on https://v7.next.forgejo.org.
![Filling account information](../_images/user/oauth2-provider/authsource-intro-login-create.png)
- You are redirected to the home page of the newly created account.
![User home page](../_images/user/oauth2-provider/authsource-intro-login-home.png)
### Confidential client
**Note:** This example does not use PKCE.

View file

@ -1,7 +1,7 @@
---
title: 'Alpine Packages Repository'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/alpine.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/alpine.en-us.md'
---
Publish [Alpine](https://pkgs.alpinelinux.org/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Cargo Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/cargo.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/cargo.en-us.md'
---
Publish [Cargo](https://doc.rust-lang.org/stable/cargo/) packages for your user or organization.
@ -16,7 +16,7 @@ The following section describes how to create it.
## Index Repository
Cargo stores informations about the available packages in a package index stored in a git repository.
Cargo stores information about the available packages in a package index stored in a git repository.
In Forgejo this repository has the special name `_cargo-index`.
After a package was uploaded, its metadata is automatically written to the index.
The content of this repository should not be manually modified.

View file

@ -1,7 +1,7 @@
---
title: 'Chef Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/chef.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/chef.en-us.md'
---
Publish [Chef](https://chef.io/) cookbooks for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Composer Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/composer.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/composer.en-us.md'
---
Publish [Composer](https://getcomposer.org/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Conan Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/conan.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/conan.en-us.md'
---
Publish [Conan](https://conan.io/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Conda Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/conda.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/conda.en-us.md'
---
Publish [Conda](https://docs.conda.io/en/latest/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Container Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/container.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/container.en-us.md'
---
Publish [Open Container Initiative](https://opencontainers.org/) compliant images for your user or organization.
@ -37,7 +37,7 @@ docker build -t {registry}/{owner}/{image}:{tag} .
docker tag {some-existing-image}:{tag} {registry}/{owner}/{image}:{tag}
```
where your registry is the domain of your gitea instance (e.g. gitea.example.com).
where your registry is the domain of your forgejo instance (e.g. forgejo.example.com).
For example, these are all valid image names for the owner `testuser`:
`forgejo.example.com/testuser/myimage`

View file

@ -1,7 +1,7 @@
---
title: 'CRAN Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/cran.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/cran.en-us.md'
---
Publish [R](https://www.r-project.org/) packages to a [CRAN](https://cran.r-project.org/)-like registry for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Debian Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/debian.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/debian.en-us.md'
---
Publish [Debian](https://www.debian.org/distrib/packages) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Generic Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/generic.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/generic.en-us.md'
---
Publish generic files, like release binaries or other output, for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Go Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/go.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/go.en-us.md'
---
Publish Go packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Helm Chart Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/helm.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/helm.en-us.md'
---
Publish [Helm](https://helm.sh/) charts for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/storage.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/storage.en-us.md'
---
## Supported package managers
@ -96,12 +96,12 @@ Previously published packages are not deleted by disabling the Package Registry.
## Deduplication
The package registry has a build-in deduplication of uploaded blobs.
The package registry has a built-in deduplication of uploaded blobs.
If two identical files are uploaded only one blob is saved on the filesystem.
This ensures no space is wasted for duplicated files.
If two packages are uploaded with identical files, both packages will display the same size but on the filesystem they require only half of the size.
Whenever a package gets deleted only the references to the underlaying blobs are removed.
Whenever a package gets deleted only the references to the underlying blobs are removed.
The blobs get not removed at this moment, so they still require space on the filesystem.
When a new package gets uploaded the existing blobs may get referenced again.
@ -145,7 +145,7 @@ The patterns are case-insensitive which matches the behaviour of the package reg
### How the cleanup rules work
The cleanup rules are part of the [clean up job]../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
The cleanup rules are part of the [clean up job](../../admin/config-cheat-sheet/#cron---cleanup-expired-packages-croncleanup_packages) and run periodically.
The cleanup rule:

View file

@ -1,7 +1,7 @@
---
title: 'Maven Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/maven.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/maven.en-us.md'
---
Publish [Maven](https://maven.apache.org) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'npm Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/npm.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/npm.en-us.md'
---
Publish [npm](https://www.npmjs.com/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'NuGet Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/nuget.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/nuget.en-us.md'
---
Publish [NuGet](https://www.nuget.org/) packages for your user or organization. The package registry supports the V2 and V3 API protocol and you can work with [NuGet Symbol Packages](https://docs.microsoft.com/en-us/nuget/create-packages/symbol-packages-snupkg) too.

View file

@ -1,7 +1,7 @@
---
title: 'Pub Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/pub.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/pub.en-us.md'
---
Publish [Pub](https://dart.dev/guides/packages) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'PyPI Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/pypi.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/pypi.en-us.md'
---
Publish [PyPI](https://pypi.org/) packages for your user or organization.

View file

@ -1,7 +1,7 @@
---
title: 'RPM Package Registry'
license: 'Apache-2.0'
origin_url: 'https://github.com/go-gitea/gitea/blob/d3982bcd814bac93e3cbce1c7eb749b17e413fbd/docs/content/usage/packages/rpm.en-us.md'
origin_url: 'https://github.com/go-gitea/gitea/blob/e865de1e9d65dc09797d165a51c8e705d2a86030/docs/content/usage/packages/rpm.en-us.md'
---
Publish [RPM](https://rpm.org/) packages for your user or organization.

Some files were not shown because too many files have changed in this diff Show more