forgejo-docs/docs/developer/index.md

---
title: 'Forgejo Developer Guide'
---

This area will be targeted to people who want to hack Forgejo and adjust it to
their needs.

- For everyone involved
  - [Code of Conduct](./coc/)
  - [Bugs, features, security and others discussions](./discussions/)
  - [Governance](./governance/)
  - [Sustainability and funding](https://codeberg.org/forgejo/sustainability)
- For contributors
  - [Compiling from source](./from-source/)
  - [Testing](./testing/)
  - [Development environment](./development-environment/)
  - [Interface customization](./customization/)
  - [Architecture overview](./architecture/)
  - [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/)
  - [Localization admin duties](./localization-admin/)
  - [Dependency management](./dependencies/)
- For maintainers
  - [Hardware infrastructure](./infrastructure/)
  - [Release management](./release/)
  - [Managing dependencies between repositories](./repositories-dependencies/)
  - [Secrets](./secrets/)
split the documentation into user/developer/admin 2023-03-01 12:47:26 -05:00			`---`
Capitalize titles of guide index pages 2024-03-17 15:50:02 -04:00			`title: 'Forgejo Developer Guide'`
split the documentation into user/developer/admin 2023-03-01 12:47:26 -05:00			`---`

Describe target audiences Since we have different types of documentation I consider it helpful to have a one-liner explaining who we want to reach with each part. Signed-off-by: André Jaenisch <andre.jaenisch@posteo.de> 2023-03-03 14:58:14 -05:00			`This area will be targeted to people who want to hack Forgejo and adjust it to`
docs: developer: code.forgejo.org Refs: https://codeberg.org/forgejo/discussions/issues/10 2023-03-18 07:24:47 -04:00			`their needs.`

docs: verbatim copy from the Forgejo CONTRIBUTING directory # Conflicts: # developer/COC.md # developer/DCO.md # developer/DISCUSSIONS.md # developer/GOVERNANCE.md # developer/RELEASE.md # developer/SECRETS.md # developer/WORKFLOW.md 2023-05-02 14:24:22 -04:00			`- For everyone involved`
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md 2023-07-26 18:20:30 -04:00			`- [Code of Conduct](./coc/)`
			`- [Bugs, features, security and others discussions](./discussions/)`
			`- [Governance](./governance/)`
developer:fix link (sustainability) 2023-09-03 16:05:50 -04:00			`- [Sustainability and funding](https://codeberg.org/forgejo/sustainability)`
docs: verbatim copy from the Forgejo CONTRIBUTING directory # Conflicts: # developer/COC.md # developer/DCO.md # developer/DISCUSSIONS.md # developer/GOVERNANCE.md # developer/RELEASE.md # developer/SECRETS.md # developer/WORKFLOW.md 2023-05-02 14:24:22 -04:00			`- For contributors`
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md 2023-07-26 18:20:30 -04:00			`- [Compiling from source](./from-source/)`
developer: testing: split this section out of compilation 2024-02-21 13:51:05 -05:00			`- [Testing](./testing/)`
Add page to document how to set up a dev environment 2023-12-04 08:40:57 -05:00			`- [Development environment](./development-environment/)`
{admin,developer}/customization: add user interface customization (#244) Reviewed-on: https://codeberg.org/forgejo/docs/pulls/244 Reviewed-by: Loïc Dachary <dachary@noreply.codeberg.org> Co-authored-by: Earl Warren <contact@earl-warren.org> Co-committed-by: Earl Warren <contact@earl-warren.org> 2023-11-15 16:23:43 -05:00			`- [Interface customization](./customization/)`
developer: add ARCHITECTURE file - As per https://codeberg.org/forgejo/discussions/issues/53#issuecomment-1070207 2023-08-27 01:03:19 -04:00			`- [Architecture overview](./architecture/)`
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md 2023-07-26 18:20:30 -04:00			`- [Developer Certificate of Origin (DCO)](./dco/)`
			`- [code.forgejo.org](./code-forgejo-org/)`
Add next.forgejo.org documentation 2023-08-29 21:49:52 -04:00			`- [next.forgejo.org](./next-forgejo-org/)`
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 05:23:09 -04:00			`- [static pages](./static-pages/)`
docs: developer: move the runner development notes to the sources # Conflicts: # developer/forgejo-runner.md 2023-05-30 06:59:08 -04:00			`- [Forgejo runner implementation notes](https://code.forgejo.org/forgejo/runner/#hacking)`
developer: add localization contribution guide 2024-01-22 10:10:34 -05:00			`- [Localization](./localization/)`
developer: add Base localization guide 2024-03-11 09:00:00 -04:00			`- [Base localization](./localization-english/)`
developer: localization: document admin duties 2024-02-09 12:40:39 -05:00			`- [Localization admin duties](./localization-admin/)`
developer: dependency management guide 2024-04-03 04:40:14 -04:00			`- [Dependency management](./dependencies/)`
docs: verbatim copy from the Forgejo CONTRIBUTING directory # Conflicts: # developer/COC.md # developer/DCO.md # developer/DISCUSSIONS.md # developer/GOVERNANCE.md # developer/RELEASE.md # developer/SECRETS.md # developer/WORKFLOW.md 2023-05-02 14:24:22 -04:00			`- For maintainers`
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md 2023-07-26 18:20:30 -04:00			`- [Hardware infrastructure](./infrastructure/)`
			`- [Release management](./release/)`
develop/repositories-dependencies: explain the cascading-pr setup It provides two concrete examples to illustrate how they are useful. It also explains how the permissions and tokens are created and installed. 2023-10-26 11:45:06 -04:00			`- [Managing dependencies between repositories](./repositories-dependencies/)`
refactor: use astro content collections for docs Reviewed-on: https://codeberg.org/forgejo/website/pulls/323 # Conflicts: # v1.19/admin/command-line.md # v1.19/admin/config-cheat-sheet.md # v1.19/admin/database-preparation.md # v1.19/admin/email-setup.md # v1.19/admin/incoming-email.md # v1.19/admin/index.md # v1.19/admin/logging-documentation.md # v1.19/admin/reverse-proxy.md # v1.19/admin/seek-assistance.md # v1.19/admin/upgrade.md # v1.19/developer/code-forgejo-org.md # v1.19/developer/index.md # v1.19/index.md # v1.19/license.md # v1.19/user/agit-support.md # v1.19/user/api-usage.md # v1.19/user/authentication.md # v1.19/user/email-settings.md # v1.19/user/first-repository.md # v1.19/user/index.md # v1.19/user/issue-pull-request-templates.md # v1.19/user/issue-tracking-basics.md # v1.19/user/labels.md # v1.19/user/linked-references.md # v1.19/user/merge-message-templates.md # v1.19/user/oauth2-provider.md # v1.19/user/packages/cargo.md # v1.19/user/packages/chef.md # v1.19/user/packages/composer.md # v1.19/user/packages/conan.md # v1.19/user/packages/conda.md # v1.19/user/packages/container.md # v1.19/user/packages/generic.md # v1.19/user/packages/helm.md # v1.19/user/packages/index.md # v1.19/user/packages/maven.md # v1.19/user/packages/npm.md # v1.19/user/packages/nuget.md # v1.19/user/packages/pub.md # v1.19/user/packages/pypi.md # v1.19/user/packages/rubygems.md # v1.19/user/packages/storage.md # v1.19/user/packages/vagrant.md # v1.19/user/project.md # v1.19/user/protection.md # v1.19/user/push-options.md # v1.19/user/push-to-create.md # v1.19/user/repo-permissions.md # v1.19/user/webhooks.md # v1.19/user/wiki.md # v1.20/user/semver.md 2023-07-26 18:20:30 -04:00			`- [Secrets](./secrets/)`