跳转到主要内容

书籍

Forgejo 文档

Forgejo 文档。内容保持上游原样。

4 章122 页更新于 23 小时前

开始阅读

目录122

  1. 第 1 章 Mermaid 7 页
    1. 1.1 docker-access sequenceDiagram Runner->>Docker: Start job container create participant Ubuntu as Job Container ... 23 小时前
    2. 1.2 repo-migration-issue-index sequenceDiagram participant migrations/migrate.go participant github.go participant gitea_uploa... 23 小时前
    3. 1.3 Admin Sets Instance Message For First Time sequenceDiagram participant adm as Admin participant front as Forgejo Frontend participant back... 23 小时前
    4. 1.4 Saving confirmation sequenceDiagram participant usr as New User participant front as Front End participant back as ... 23 小时前
    5. 1.5 Service Message Shown At Login sequenceDiagram participant adm as Admin participant usr as New User participant repo as Forgej... 23 小时前
    6. 1.6 threat-analysis-remote-login-propagation sequenceDiagram participant fs as foreign_repository_server participant os as our_repository_server... 23 小时前
    7. 1.7 open-id-connect-flow sequenceDiagram autonumber participant Workflow Run participant Forgejo participant Externa... 23 小时前
  2. 第 2 章 Admin 37 页
    1. 2.1 Command-line interface Forgejo comes with a command-line interface (CLI) for administrative actions. It is documented below and is... 23 小时前
    2. 2.2 Configuration Cheat Sheet This is a cheat sheet for the Forgejo configuration file. It contains most of the settings that can be conf... 23 小时前
    3. 2.3 Forgejo Administrator Guide These documents are targeted to people who run Forgejo on their machines. Installation Introduction With Do... 23 小时前
    4. 2.4 Release schedule Forgejo stable releases are published on a fixed schedule, every quarter. The most up-to-date version is av... 23 小时前
    5. 2.5 Forgejo Runner Configuration When Forgejo identifies a job that needs to be run, it inspects the jobs' runs-on field to evaluate which ... 23 小时前
    6. 2.6 Utilizing Docker within Actions Forgejo Runner uses a container environment to run actions, but additional configuration is required to all... 23 小时前
    7. 2.7 Forgejo Actions administrator guide Forgejo Actions provides continuous integration driven from the files found in the .forgejo/workflows dire... 23 小时前
    8. 2.8 Forgejo Runner Registration Forgejo Runner requires a uuid and token to connect to Forgejo. These values act as a username and password... 23 小时前
    9. 2.9 Securing Forgejo Actions Deployments Remote code execution (RCE) is typically considered one of the most critical security vulnerabilities that ... 23 小时前
    10. 2.10 Installation from binary Forgejo Runner requires that Git is installed, and has been tested with a minimum version of Git 2.24.3. Do... 23 小时前
    11. 2.11 Installation with Docker The OCI images are built from the Dockerfile which is found in the source directory. It contains the forgej... 23 小时前
    12. 2.12 Installation from packaging NixOS 26.05 or earlier A forgejo-runner package is available for Nix. As NixOS service module services.gi... 23 小时前
    13. 2.13 Adopt existing git directories If directories containing bare git repositories exist in the [repository].ROOT hierarchy, they can be impor... 23 小时前
    14. 2.14 Interface customization Forgejo currently has limited capabilities for customizing the user interface. Configurations and UI settin... 23 小时前
    15. 2.15 Incoming Email Forgejo supports the execution of several actions through incoming mails. This page describes how to set th... 23 小时前
    16. 2.16 JWT Key Management and Rotation Forgejo uses JSON Web Tokens (JWTs) extensively for various authentication and authorization functions. Thi... 23 小时前
    17. 2.17 Moderation tools Moderation tools are meant to help the Forgejo users and admins handle spam bots and undesirable interactio... 23 小时前
    18. 2.18 OAuth2 provider The following OAuth2 applications are pre-registered because it is generally useful for Forgejo to be an OA... 23 小时前
    19. 2.19 OIDC Group Mappings Forgejo supports configuring group team mappings for OIDC authentication sources that map OIDC groups to Fo... 23 小时前
    20. 2.20 Soft-Quota Forgejo has early support for a soft-quota that can protect your server from high disk usage due to abuse o... 23 小时前
    21. 2.21 Search Engines Indexation By default, your Forgejo installation will be indexed by search engines. If you don't want your repository ... 23 小时前
    22. 2.22 Service Message The service message feature is intended for admins of instances that require their users to consent to some... 23 小时前
    23. 2.23 Instance Commit Signing Forgejo has the ability to sign commits when Forgejo themselves generates those commits, such as: Repositor... 23 小时前
    24. 2.24 Installation from binary [!note] Note This guide uses git.example.com and x.y.z for illustrative purpose. Replace with your domain a... 23 小时前
    25. 2.25 Database Preparation Forgejo uses a database to store relational data, however not every relational database can be used by Forg... 23 小时前
    26. 2.26 Installation with Docker Forgejo provides container images for use with Docker or other containerization tools. docker pull codeberg... 23 小时前
    27. 2.27 Installation Forgejo publishes a stable release every three months and a long term support (LTS) release every year. Pat... 23 小时前
    28. 2.28 Authentication Both the LDAP via BindDN and the simple auth LDAP share the following fields: Authorization Name (required)... 23 小时前
    29. 2.29 Backups and Backup Restoration As your Forgejo installation becomes a critical part of your development lifecycle, the data within it need... 23 小时前
    30. 2.30 Email setup Forgejo can be set to send emails such as a registration confirmation, either with Sendmail (or compatible ... 23 小时前
    31. 2.31 Recommended Settings and Tips The default settings are applicable to a broad range of Forgejo instances. Nevertheless, not every instance... 23 小时前
    32. 2.32 Reverse proxy Forgejo can live standalone, or behind a reverse proxy. You may want this for scenarios like: Subpath mappi... 23 小时前
    33. 2.33 Storage settings The storage for each subsystem is defined in app.ini. It can either be on disk ( local which is the defaul... 23 小时前
    34. 2.34 Logging Configuration The logging configuration of Forgejo mainly consists of 3 types of components: The [log] section for gener... 23 小时前
    35. 2.35 Profiling Forgejo is written in Go, which means Forgejo can leverage the extensive profiling tooling that is provided... 23 小时前
    36. 2.36 Seek Assistance Chatroom Issue tracker [!note] Note When asking for support, it may be a good idea to have the following av... 23 小时前
    37. 2.37 Upgrade guide This guide helps Forgejo admins perform upgrades safely and provides guidance to troubleshoot problems. It ... 23 小时前
  3. 45 Forgejo prerelease documentation What is Forgejo? Installation FAQ Administrator guide User guide Contributor guide License 23 小时前
  4. 第 3 章 Contributor 28 页
    1. 3.1 Architecture This document serves two purposes: it seeks to offer the reader a high-level grasp of how Forgejo operates,... 23 小时前
    2. 3.2 Code of Conduct and moderation team Forgejo is committed to creating an inclusive community where everyone feels welcome and safe. The well-bei... 23 小时前
    3. 3.3 Developer Certificate of Origin (DCO) Contributions to Forgejo, in all the repositories in the Forgejo organization are accepted provided the aut... 23 小时前
    4. 3.4 Bugs, features and discussions The Forgejo issue tracker is where bugs should be reported and features requested. Dedicated repositories i... 23 小时前
    5. 3.5 Governance The Forgejo domains are owned by the democratic non-profit dedicated to Free Software Codeberg e.V.. Forgej... 23 小时前
    6. 3.6 Release management See the release schedule. Stable release support Bug fixes and security fixes are backported to the latest ... 23 小时前
    7. 3.7 Secrets All Forgejo credentials are shared among the devops team in a private repository with encrypted content. Ge... 23 小时前
    8. 3.8 Web browser support New and existing Forgejo web UI features that affect usability of Forgejo should rely on browser features a... 23 小时前
    9. 3.9 code.forgejo.org https://code.forgejo.org is a Forgejo instance running the latest stable version, starting with the release... 23 小时前
    10. 3.10 Interface customization This sections documents the Forgejo interface customization that requires an intimate knowledge of the unde... 23 小时前
    11. 3.11 Dependency management Forgejo relies on hundreds of Free Software components and they all need to be updated on a regular basis, ... 23 小时前
    12. 3.12 Development environment This page lists a few options to set up a productive development environment for working on Forgejo. VSCodi... 23 小时前
    13. 3.13 Finding what to work on in Forgejo Assuming that your development environment is ready and that you are aware of how you can reach out to the ... 23 小时前
    14. 3.14 Compiling from source You should install go and set up your go environment correctly. In particular, it is recommended to set the... 23 小时前
    15. 3.15 Forgejo Contributor Guide This area is targeted to people who want to improve Forgejo and adjust it to their needs. We encourage you ... 23 小时前
    16. 3.16 Hardware infrastructure Moved permanently to https://code.forgejo.org/infrastructure/documentation#readme. A mirror is available at... 23 小时前
    17. 3.17 Managing dependencies between repositories Some Forgejo repositories that depend on each other have workflows that will trigger workflows on other rep... 23 小时前
    18. 3.18 Repository Migration The sequence diagram below shows the different go packages in the top and bottom boxes and their functions ... 23 小时前
    19. 3.19 Static pages LXC container dedicated to hosting static HTML pages. LXC container See the static-pages section in the inf... 23 小时前
    20. 3.20 Testing If you want to contribute to Forgejo, keep in mind that we ask you to do a reasonable effort to test your c... 23 小时前
    21. 3.21 Welcome to Forgejo We are happy to welcome you to the Forgejo project. Please take the time to read this page to the end. Qual... 23 小时前
    22. 3.22 Weblate admin duties Localization team members with admin rights on both Forgejo and Weblate are expected to make sure the trans... 23 小时前
    23. 3.23 English base localization Forgejo base localization is English. This means that all translations are derived from it. Managing string... 23 小时前
    24. 3.24 Localization Forgejo is translated via Weblate, a libre web-based translation platform. Translating via Weblate The Forg... 23 小时前
    25. 3.25 Service Messages Feature Description 23 小时前
    26. 3.26 Service Messages Feature Description Mastodon instances like mastodon.art provide their community rules via a mandatory dialog that has to be ac... 23 小时前
    27. 3.27 Threat Analysis Threat Analysis: Remote Login Propagation 23 小时前
    28. 3.28 Threat Analysis: Remote Login Propagation See also blog: geballte sicherheit for getting an idea about the analysis. Technical Background Control Flo... 23 小时前
  5. 74 License This documentation is licensed under CC-BY-SA 4.0. The copyright holders are listed in the git history. Som... 23 小时前
  6. 第 4 章 User 48 页
    1. 4.1 Forgejo Next https://next.forgejo.org, also known as Forgejo Next, is Forgejo's official testing and demonstration insta... 23 小时前
    2. 4.2 Comment on issues and pull requests via email [!note] Note This feature is not enabled by default; the [email.incoming].ENABLED setting must be set. Whe... 23 小时前
    3. 4.3 Forgejo User Guide These documents are targeted to people who are using Forgejo but are not involved in running it on their ma... 23 小时前
    4. 4.4 Repository Mirrors Repository mirroring allows for the mirroring of repositories to and from external sources. You can use it ... 23 小时前
    5. 4.5 Forgejo Actions | Using Actions Actions are reusable pieces of code that you can use in your CI workflows. Using Actions For example, to ch... 23 小时前
    6. 4.6 Forgejo Actions | Advanced features This page covers the more advanced features of Forgejo Actions. pre-commit hook A pre-commit hook is provi... 23 小时前
    7. 4.7 Forgejo Actions | Basic concepts This page explains the basic concepts you'll encounter when using Forgejo Actions. All Forgejo Actions work... 23 小时前
    8. 4.8 Forgejo Actions | GitHub Actions If you are familiar with GitHub Actions, you'll likely recognize many things in Forgejo Actions. Forgejo Ac... 23 小时前
    9. 4.9 Forgejo Actions | User guide Forgejo Actions is a Continuous Integration system built into Forgejo. It lets you automatically build, lin... 23 小时前
    10. 4.10 Forgejo Actions | Quick start guide This guide explains how to set up a simple Forgejo Actions workflow. The basic concepts are all mentioned h... 23 小时前
    11. 4.11 Forgejo Actions | Reference This page contains the complete reference for Forgejo Actions workflow files. For a more information on wha... 23 小时前
    12. 4.12 Forgejo Actions | Security OpenID Connect Forgejo Actions allows for workflows to request OpenID Connect compatible JWT ID tokens from Forgejo to exc... 23 小时前
    13. 4.13 Forgejo Actions | Security of Pull Requests A pull request may contain code that changes what is run by Forgejo Actions, for instance if it modifies a ... 23 小时前
    14. 4.14 Forgejo Actions | Security Forgejo Actions is a very flexible CI/CD system. It lets you write workflows that execute arbitrary code, w... 23 小时前
    15. 4.15 Forgejo Actions | Troubleshooting When a workflow or an action fails to run as expected, the following steps may help to figure out where to ... 23 小时前
    16. 4.16 Authorized Integrations Authorized Integrations provide a capability for API requests to Forgejo to be authenticated based upon a J... 23 小时前
    17. 4.17 API Forgejo's API is documented via Swagger/OpenAPI v2, the raw JSON file can be accessed via https://next.forg... 23 小时前
    18. 4.18 API Usage The Forgejo API for all versions that have the same major number (e.g. the major number of Forgejo 7.0.0 is... 23 小时前
    19. 4.19 Forgejo numbering scheme The Forgejo versions look like X.Y.Z+gitea-A.B.C (e.g., 7.0.0+gitea-1.22.0). The Forgejo version is the fi... 23 小时前
    20. 4.20 OAuth2 provider Forgejo supports acting as an OAuth2 provider to allow third party applications to access its resources wit... 23 小时前
    21. 4.21 Access Token Scope Forgejo supports scoped access tokens, which allow users to restrict tokens to operate only on selected URL... 23 小时前
    22. 4.22 Blocking a user Blocking another user is desirable if they are acting maliciously or are spamming your repository (for inst... 23 小时前
    23. 4.23 Labels You can use labels to classify issues and pull requests and to improve your overview of them. Labels can be... 23 小时前
    24. 4.24 Automatically Linked References in Issues, Pull Requests, and Commit Messages When an issue, pull request, or comment is posted, the text description is parsed in search of references. ... 23 小时前
    25. 4.25 Profile customization By default, the profile page of a user (or an organization) is the list of repositories they own. It is pos... 23 小时前
    26. 4.26 Projects A project is a kanban board to organize issues. Card previews images If the card preview in the project is ... 23 小时前
    27. 4.27 Pull requests and Git flow TLDR: Keep an eye on your repository and organization permissions. Don't take sweets from strangers. Use pu... 23 小时前
    28. 4.28 Repository Permissions When you invite collaborators to join your repository or when you create teams for your organization, you h... 23 小时前
    29. 4.29 Repository Activity For each repository, the Activity tab displays insights about the recent changes. It helps figure out how l... 23 小时前
    30. 4.30 Email Settings By default, Forgejo will send notifications to your registered email addresses. This section only concerns ... 23 小时前
    31. 4.31 Your First Repository Almost everything on Forgejo happens in a repository. Think of a repository as a home for your project, whe... 23 小时前
    32. 4.32 Getting started Your first steps on Forgejo. 23 小时前
    33. 4.33 The Basics of Issue Tracking Issues are an important means of communication on Forgejo. Besides their original purpose - reporting bugs ... 23 小时前
    34. 4.34 Integrated Wiki A wiki is a collaborative space on the web. It is a common practice to use wikis to collect knowledge and s... 23 小时前
    35. 4.35 AGit Workflow Usage Forgejo ships with custom support for AGit-Flow. Similarly to Gerrit's workflow, this workflow provides a w... 23 小时前
    36. 4.36 Git CLI Forgejo supports git push and git pull, but you can do more with the git command. Creating pull requests... 23 小时前
    37. 4.37 Push To Create Push to create is a feature that allows you to push to a repository that does not yet exist in Forgejo. Thi... 23 小时前
    38. 4.38 Blame File View Forgejo supports viewing the line-by-line revision history for a file, also known as blame view. You can al... 23 小时前
    39. 4.39 FUNDING files Forgejo supports parsing a FUNDING.yml file found in a repository and presenting its contents in various c... 23 小时前
    40. 4.40 Issue and Pull Request Templates Some projects have a standard list of questions that users need to answer when creating an issue or pull re... 23 小时前
    41. 4.41 Programming language detection Forgejo tries to detect the languages used in a repository, for each file, to use this information in a num... 23 小时前
    42. 4.42 Merge Message Templates Possible file names for PR (Pull Request) default merge message templates: .forgejo/default_merge_message/M... 23 小时前
    43. 4.43 Branch and tag protection Protected branches enforce restrictions such as force pushing or merging unless a given number of approvals... 23 小时前
    44. 4.44 README badges If the badges service is enabled, Forgejo makes it possible to add badges - transparently generated by a se... 23 小时前
    45. 4.45 Tags and Releases Tags are a feature in Git that can be used to make a snapshot of a repository from a point in time. It is g... 23 小时前
    46. 4.46 Webhooks Forgejo supports webhooks for repository events. This can be configured on the settings page /:username/:r... 23 小时前
    47. 4.47 Code Search Forgejo supports code search through an indexer and git-grep as a fallback when REPO_INDEXER_ENABLED is d... 23 小时前
    48. 4.48 Issue Search Since v11, Issue search on Forgejo replaced its previously dropdown-defined behavior of searches with a que... 23 小时前