From 581d02f1d796b84b3312a05911b91802fbc0f1cc Mon Sep 17 00:00:00 2001 From: Caesar Schinas Date: Sun, 27 Aug 2023 00:02:54 +0100 Subject: [PATCH] s/Gitea/Forgejo/ --- docs/admin/config-cheat-sheet.md | 4 ++-- docs/admin/seek-assistance.md | 2 +- docs/admin/upgrade.md | 6 +++--- docs/developer/RELEASE.md | 4 ++-- docs/developer/WORKFLOW.md | 12 ++++++------ 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/admin/config-cheat-sheet.md b/docs/admin/config-cheat-sheet.md index 9da2237d..ee402224 100644 --- a/docs/admin/config-cheat-sheet.md +++ b/docs/admin/config-cheat-sheet.md @@ -334,7 +334,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a - `SSH_SERVER_MACS`: **hmac-sha2-256-etm@openssh.com, hmac-sha2-256, hmac-sha1**: For the built-in SSH server, choose the MACs to support for SSH connections, for system SSH this setting has no effect - `SSH_SERVER_HOST_KEYS`: **ssh/gitea.rsa, ssh/gogs.rsa**: For the built-in SSH server, choose the keypairs to offer as the host key. The private key should be at `SSH_SERVER_HOST_KEY` and the public `SSH_SERVER_HOST_KEY.pub`. Relative paths are made absolute relative to the `APP_DATA_PATH`. If no key exists a 4096 bit RSA key will be created for you. - `SSH_KEY_TEST_PATH`: **/tmp**: Directory to create temporary files in when testing public keys using ssh-keygen, default is the system temporary directory. -- `SSH_KEYGEN_PATH`: **\**: Use `ssh-keygen` to parse public SSH keys. The value is passed to the shell. By default, Gitea does the parsing itself. +- `SSH_KEYGEN_PATH`: **\**: Use `ssh-keygen` to parse public SSH keys. The value is passed to the shell. By default, Forgejo does the parsing itself. - `SSH_EXPOSE_ANONYMOUS`: **false**: Enable exposure of SSH clone URL to anonymous visitors, default is false. - `SSH_PER_WRITE_TIMEOUT`: **30s**: Timeout for any write to the SSH connections. (Set to -1 to disable all timeouts.) @@ -354,7 +354,7 @@ The following configuration set `Content-Type: application/vnd.android.package-a - `LFS_START_SERVER`: **false**: Enables Git LFS support. - `LFS_CONTENT_PATH`: **%(APP_DATA_PATH)s/lfs**: Default LFS content path. (if it is on local storage.) **DEPRECATED** use settings in `[lfs]`. - `LFS_JWT_SECRET`: **\**: LFS authentication secret, change this a unique string. -- `LFS_JWT_SECRET_URI`: **\**: Instead of defining LFS_JWT_SECRET in the configuration, this configuration option can be used to give Gitea a path to a file that contains the secret (example value: `file:/etc/gitea/lfs_jwt_secret`) +- `LFS_JWT_SECRET_URI`: **\**: Instead of defining LFS_JWT_SECRET in the configuration, this configuration option can be used to give Forgejo a path to a file that contains the secret (example value: `file:/etc/forgejo/lfs_jwt_secret`) - `LFS_HTTP_AUTH_EXPIRY`: **24h**: LFS authentication validity period in time.Duration, pushes taking longer than this may fail. - `LFS_MAX_FILE_SIZE`: **0**: Maximum allowed LFS file size in bytes (Set to 0 for no limit). - `LFS_LOCKS_PAGING_NUM`: **50**: Maximum number of LFS Locks returned per page. diff --git a/docs/admin/seek-assistance.md b/docs/admin/seek-assistance.md index d5e26cf0..3e064b92 100644 --- a/docs/admin/seek-assistance.md +++ b/docs/admin/seek-assistance.md @@ -26,7 +26,7 @@ origin_url: 'https://github.com/go-gitea/gitea/blob/faa28b5a44912f1c63afddab9396 ROUTER=console,file XORM=console,file ENABLE_XORM_LOG=true - FILE_NAME=gitea.log + FILE_NAME=forgejo.log [log.file.router] FILE_NAME=router.log [log.file.xorm] diff --git a/docs/admin/upgrade.md b/docs/admin/upgrade.md index bb3b1c1b..de6eacc1 100644 --- a/docs/admin/upgrade.md +++ b/docs/admin/upgrade.md @@ -4,7 +4,7 @@ license: 'CC-BY-SA-4.0' origin_url: 'https://forgejo.gna.org/Hostea/admin-guide/src/branch/master/README.md' --- -This guide helps Forgejo admins perform upgrades safely and provides guidance to troubleshoot problems. It covers upgrades from Gitea back to version 1.2.0. +This guide helps Forgejo admins perform upgrades safely and provides guidance to troubleshoot problems. It also covers upgrades from Gitea back to version 1.2.0. ### Backup @@ -45,7 +45,7 @@ Note: Forgejo requires [docker >= 20.10.6](https://wiki.alpinelinux.org/wiki/Rel - Upgrade to 1.4.3 and manually verify it runs - Upgrade to 1.5.3 and manually verify it runs - Upgrade to 1.6.4 and manually verify it runs -- If the upgrade is from a Gitea version greater or equal to 1.6.4 that is not mentioned to be problematic below, upgrade directly to the latest stable Forgejo version, there is no need to upgrade to intermediate versions. +- If the upgrade is from a Gitea version greater or equal to 1.6.4 that is not mentioned to be problematic [below](#when-upgrading-from-a-specific-version), upgrade directly to the latest stable Forgejo version; there is no need to upgrade to intermediate versions. - Verify Forgejo works ### Troubleshooting @@ -59,7 +59,7 @@ Note: Forgejo requires [docker >= 20.10.6](https://wiki.alpinelinux.org/wiki/Rel ROUTER=console,file XORM=console,file ENABLE_XORM_LOG=true - FILE_NAME=gitea.log + FILE_NAME=forgejo.log [log.file.router] FILE_NAME=router.log [log.file.xorm] diff --git a/docs/developer/RELEASE.md b/docs/developer/RELEASE.md index 7c33e300..74eba81b 100644 --- a/docs/developer/RELEASE.md +++ b/docs/developer/RELEASE.md @@ -41,7 +41,7 @@ The TL;DR: to publish a vX.Y.Z-N release is to: ### Cherry pick the latest commits from Gitea -The vX.Y/forgejo branch is populated as part of the [rebase on top of Gitea](./workflow/). The release happens in between rebase and it is worth checking if the matching Gitea branch, release/vX.Y contains commits that should be included in the release. +The vX.Y/forgejo branch is populated as part of the [rebase on top of Gitea](../workflow/). The release happens in between rebase and it is worth checking if the matching Gitea branch, release/vX.Y contains commits that should be included in the release. - `cherry-pick -x` the commits - push the vX.Y/forgejo branch including the commits @@ -114,7 +114,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 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. ### Website update diff --git a/docs/developer/WORKFLOW.md b/docs/developer/WORKFLOW.md index 72cd8459..d2f8095b 100644 --- a/docs/developer/WORKFLOW.md +++ b/docs/developer/WORKFLOW.md @@ -9,15 +9,15 @@ Forgejo is a set of commits applied to the Gitea development branch and the stab ### Development -- Gitea: main -- Forgejo: forgejo -- Feature branches: forgejo-feature-name +- Gitea: `main` +- Forgejo: `forgejo` +- Feature branches: `forgejo-feature-name` ### Stable -- Gitea: release/vX.Y -- Forgejo: vX.Y/forgejo -- Feature branches: vX.Y/forgejo-feature-name +- Gitea: `release/vX.Y` +- Forgejo: `vX.Y/forgejo` +- Feature branches: `vX.Y/forgejo-feature-name` ### Branches history