646b892680
Some checks failed
Periodic Merges (6h) / master → staging-nixos (push) Failing after 12m50s
Periodic Merges (6h) / master → staging-next (push) Failing after 12m54s
Periodic Merges (24h) / merge-base(master,staging) → haskell-updates (push) Failing after 11m54s
Periodic Merges (6h) / staging-next → staging (push) Failing after 12m13s
Periodic Merges (24h) / staging-next-25.05 → staging-25.05 (push) Failing after 13m24s
Periodic Merges (24h) / release-25.05 → staging-next-25.05 (push) Failing after 14m28s
120 lines
3.7 KiB
Markdown
120 lines
3.7 KiB
Markdown
# Forgejo {#module-forgejo}
|
|
|
|
Forgejo is a soft-fork of gitea, with strong community focus, as well
|
|
as on self-hosting and federation. [Codeberg](https://codeberg.org) is
|
|
deployed from it.
|
|
|
|
See [upstream docs](https://forgejo.org/docs/latest/).
|
|
|
|
The method of choice for running forgejo is using [`services.forgejo`](#opt-services.forgejo.enable).
|
|
|
|
::: {.warning}
|
|
Running forgejo using `services.gitea.package = pkgs.forgejo` is no longer
|
|
recommended.
|
|
If you experience issues with your instance using `services.gitea`,
|
|
**DO NOT** report them to the `services.gitea` module maintainers.
|
|
**DO** report them to the `services.forgejo` module maintainers instead.
|
|
:::
|
|
|
|
## Migration from Gitea {#module-forgejo-migration-gitea}
|
|
|
|
::: {.note}
|
|
Migrating is, while not strictly necessary at this point, highly recommended.
|
|
Both modules and projects are likely to diverge further with each release.
|
|
Which might lead to an even more involved migration.
|
|
:::
|
|
|
|
::: {.warning}
|
|
The last supported version of Forgejo which supports migration from Gitea is
|
|
*10.0.x*. You should *NOT* try to migrate from Gitea to Forgejo `11.x` or
|
|
higher without first migrating to `10.0.x`.
|
|
|
|
See [upstream migration guide](https://forgejo.org/docs/latest/admin/gitea-migration/)
|
|
|
|
The last supported version of *Gitea* for this migration process is *1.22*. Do
|
|
*NOT* try to directly migrate from Gitea *1.23* or higher, as it will likely
|
|
result in data loss.
|
|
|
|
See [upstream news article](https://forgejo.org/2024-12-gitea-compatibility/)
|
|
:::
|
|
|
|
In order to migrate, the version of Forgejo needs to be pinned to `10.0.x`
|
|
*before* using the latest version. This means that nixpkgs commit
|
|
[`3bb45b041e7147e2fd2daf689e26a1f970a55d65`](https://github.com/NixOS/nixpkgs/commit/3bb45b041e7147e2fd2daf689e26a1f970a55d65)
|
|
or earlier should be used.
|
|
|
|
To do this, temporarily add the following to your `configuration.nix`:
|
|
|
|
```nix
|
|
{ pkgs, ... }:
|
|
let
|
|
nixpkgs-forgejo-10 = import (pkgs.fetchFromGitHub {
|
|
owner = "NixOS";
|
|
repo = "nixpkgs";
|
|
rev = "3bb45b041e7147e2fd2daf689e26a1f970a55d65";
|
|
hash = "sha256-8JL5NI9eUcGzzbR/ARkrG81WLwndoxqI650mA/4rUGI=";
|
|
}) { };
|
|
in
|
|
{
|
|
services.forgejo.package = nixpkgs-forgejo-10.forgejo;
|
|
}
|
|
```
|
|
|
|
### Full-Migration {#module-forgejo-migration-gitea-default}
|
|
|
|
This will migrate the state directory (data), rename and chown the database and
|
|
delete the gitea user.
|
|
|
|
::: {.note}
|
|
This will also change the git remote ssh-url user from `gitea@` to `forgejo@`,
|
|
when using the host's openssh server (default) instead of the integrated one.
|
|
:::
|
|
|
|
Instructions for PostgreSQL (default). Adapt accordingly for other databases:
|
|
|
|
```sh
|
|
systemctl stop gitea
|
|
mv /var/lib/gitea /var/lib/forgejo
|
|
runuser -u postgres -- psql -c '
|
|
ALTER USER gitea RENAME TO forgejo;
|
|
ALTER DATABASE gitea RENAME TO forgejo;
|
|
'
|
|
nixos-rebuild switch
|
|
systemctl stop forgejo
|
|
chown -R forgejo:forgejo /var/lib/forgejo
|
|
systemctl restart forgejo
|
|
```
|
|
|
|
Afterwards, the Forgejo version can be set back to a newer desired version.
|
|
|
|
### Alternatively, keeping the gitea user {#module-forgejo-migration-gitea-impersonate}
|
|
|
|
Alternatively, instead of renaming the database, copying the state folder and
|
|
changing the user, the forgejo module can be set up to re-use the old storage
|
|
locations and database, instead of having to copy or rename them.
|
|
Make sure to disable `services.gitea`, when doing this.
|
|
|
|
```nix
|
|
{
|
|
services.gitea.enable = false;
|
|
|
|
services.forgejo = {
|
|
enable = true;
|
|
user = "gitea";
|
|
group = "gitea";
|
|
stateDir = "/var/lib/gitea";
|
|
database.name = "gitea";
|
|
database.user = "gitea";
|
|
};
|
|
|
|
users.users.gitea = {
|
|
home = "/var/lib/gitea";
|
|
useDefaultShell = true;
|
|
group = "gitea";
|
|
isSystemUser = true;
|
|
};
|
|
|
|
users.groups.gitea = { };
|
|
}
|
|
```
|