245 lines
7.3 KiB
Markdown
245 lines
7.3 KiB
Markdown
# Forgejo Service {#services-forgejo}
|
|
|
|
Defined in [`/modules/services/forgejo.nix`](@REPO@/modules/services/forgejo.nix).
|
|
|
|
This NixOS module is a service that sets up a [Forgejo](https://forgejo.org/) instance.
|
|
|
|
Compared to the stock module from nixpkgs,
|
|
this one sets up, in a fully declarative manner,
|
|
LDAP and SSO integration as well as one local runner.
|
|
|
|
## Features {#services-forgejo-features}
|
|
|
|
- Declarative [LDAP](#services-forgejo-options-shb.forgejo.ldap) Configuration. [Manual](#services-forgejo-usage-ldap).
|
|
- Declarative [SSO](#services-forgejo-options-shb.forgejo.sso) Configuration. [Manual](#services-forgejo-usage-sso).
|
|
- Declarative [local runner](#services-forgejo-options-shb.forgejo.localActionRunner) Configuration.
|
|
- Access through [subdomain](#services-forgejo-options-shb.forgejo.subdomain) using reverse proxy. [Manual](#services-forgejo-usage-basic).
|
|
- Access through [HTTPS](#services-forgejo-options-shb.forgejo.ssl) using reverse proxy. [Manual](#services-forgejo-usage-basic).
|
|
- [Backup](#services-forgejo-options-shb.forgejo.sso) through the [backup block](./blocks-backup.html) with the . [Manual](#services-forgejo-usage-backup).
|
|
|
|
## Usage {#services-forgejo-usage}
|
|
|
|
### Secrets {#services-forgejo-secrets}
|
|
|
|
All the secrets should be readable by the forgejo user.
|
|
|
|
Secrets should not be stored in the nix store.
|
|
If you're using [sops-nix](https://github.com/Mic92/sops-nix)
|
|
and assuming your secrets file is located at `./secrets.yaml`,
|
|
you can define a secret with:
|
|
|
|
```nix
|
|
sops.secrets."forgejo/adminPasswordFile" = {
|
|
sopsFile = ./secrets.yaml;
|
|
mode = "0400";
|
|
owner = "forgejo";
|
|
group = "forgejo";
|
|
restartUnits = [ "forgejo.service" ];
|
|
};
|
|
```
|
|
|
|
Then you can use that secret:
|
|
|
|
```nix
|
|
shb.forgejo.adminPasswordFile = config.sops.secrets."forgejo/adminPasswordFile".path;
|
|
```
|
|
|
|
### Forgejo through HTTP(S) {#services-forgejo-usage-basic}
|
|
|
|
This will set up a Forgejo service that runs on the NixOS target machine,
|
|
reachable at `http://forgejo.example.com`.
|
|
|
|
```nix
|
|
shb.forgejo = {
|
|
enable = true;
|
|
domain = "example.com";
|
|
subdomain = "forgejo";
|
|
};
|
|
```
|
|
|
|
If the `shb.ssl` block is used (see [manual](blocks-ssl.html#usage) on how to set it up),
|
|
the instance will be reachable at `https://fogejo.example.com`.
|
|
|
|
Here is an example with self-signed certificates:
|
|
|
|
```nix
|
|
shb.certs = {
|
|
cas.selfsigned.myca = {
|
|
name = "My CA";
|
|
};
|
|
certs.selfsigned = {
|
|
foregejo = {
|
|
ca = config.shb.certs.cas.selfsigned.myca;
|
|
domain = "forgejo.example.com";
|
|
};
|
|
};
|
|
};
|
|
```
|
|
|
|
Then you can tell Forgejo to use those certificates.
|
|
|
|
```nix
|
|
shb.forgejo = {
|
|
ssl = config.shb.certs.certs.selfsigned.forgejo;
|
|
};
|
|
```
|
|
|
|
### With LDAP Support {#services-forgejo-usage-ldap}
|
|
|
|
:::: {.note}
|
|
We will build upon the [Forgejo through HTTP(S)](#services-forgejo-usage-basic) section,
|
|
so please follow that first.
|
|
::::
|
|
|
|
We will use the LDAP block provided by Self Host Blocks
|
|
to setup a [LLDAP](https://github.com/lldap/lldap) service.
|
|
|
|
```nix
|
|
shb.ldap = {
|
|
enable = true;
|
|
domain = "example.com";
|
|
subdomain = "ldap";
|
|
ldapPort = 3890;
|
|
webUIListenPort = 17170;
|
|
dcdomain = "dc=example,dc=com";
|
|
ldapUserPasswordFile = <path/to/ldapUserPasswordSecret>;
|
|
jwtSecretFile = <path/to/ldapJwtSecret>;
|
|
};
|
|
```
|
|
|
|
We also need to configure the `forgejo` service
|
|
to talk to the LDAP server we just defined:
|
|
|
|
```nix
|
|
shb.forgejo.ldap
|
|
enable = true;
|
|
host = "127.0.0.1";
|
|
port = config.shb.ldap.ldapPort;
|
|
dcdomain = config.shb.ldap.dcdomain;
|
|
adminPasswordFile = <path/to/ldapUserPasswordSecret>;
|
|
};
|
|
```
|
|
|
|
The `shb.forgejo.ldap.adminPasswordFile` must be the same
|
|
as the `shb.ldap.ldapUserPasswordFile`.
|
|
The other secrets can be randomly generated with
|
|
`nix run nixpkgs#openssl -- rand -hex 64`.
|
|
|
|
And that's it.
|
|
Now, go to the LDAP server at `http://ldap.example.com`,
|
|
create the `forgejo_user` and `forgejo_admin` groups,
|
|
create a user and add it to one or both groups.
|
|
When that's done, go back to the Forgejo server at
|
|
`http://forgejo.example.com` and login with that user.
|
|
|
|
### With SSO Support {#services-forgejo-usage-sso}
|
|
|
|
:::: {.note}
|
|
We will build upon the [With LDAP Support](#services-forgejo-usage-ldap) section,
|
|
so please follow that first.
|
|
::::
|
|
|
|
Here though, we must setup SSL certificates
|
|
because the SSO provider only works with the https protocol.
|
|
Let's add self-signed certificates for Authelia and LLDAP:
|
|
|
|
```nix
|
|
shb.certs = {
|
|
certs.selfsigned = {
|
|
auth = {
|
|
ca = config.shb.certs.cas.selfsigned.myca;
|
|
domain = "auth.example.com";
|
|
};
|
|
ldap = {
|
|
ca = config.shb.certs.cas.selfsigned.myca;
|
|
domain = "ldap.example.com";
|
|
};
|
|
};
|
|
};
|
|
```
|
|
|
|
We then need to setup the SSO provider,
|
|
here Authelia thanks to the corresponding SHB block:
|
|
|
|
```nix
|
|
shb.authelia = {
|
|
enable = true;
|
|
domain = "example.com";
|
|
subdomain = "auth";
|
|
ssl = config.shb.certs.certs.selfsigned.auth;
|
|
|
|
ldapHostname = "127.0.0.1";
|
|
ldapPort = config.shb.ldap.ldapPort;
|
|
dcdomain = config.shb.ldap.dcdomain;
|
|
|
|
secrets = {
|
|
jwtSecretFile = <path/to/autheliaJwtSecret>;
|
|
ldapAdminPasswordFile = <path/to/ldapUserPasswordSecret>;
|
|
sessionSecretFile = <path/to/autheliaSessionSecret>;
|
|
storageEncryptionKeyFile = <path/to/autheliaStorageEncryptionKeySecret>;
|
|
identityProvidersOIDCHMACSecretFile = <path/to/providersOIDCHMACSecret>;
|
|
identityProvidersOIDCIssuerPrivateKeyFile = <path/to/providersOIDCIssuerSecret>;
|
|
};
|
|
};
|
|
```
|
|
|
|
The `shb.authelia.secrets.ldapAdminPasswordFile` must be the same
|
|
as the `shb.ldap.ldapUserPasswordFile` defined in the previous section.
|
|
The other secrets can be randomly generated
|
|
with `nix run nixpkgs#openssl -- rand -hex 64`.
|
|
|
|
Now, on the forgejo side, you need to add the following options:
|
|
|
|
```nix
|
|
shb.forgejo.sso = {
|
|
enable = true;
|
|
endpoint = "https://${config.shb.authelia.subdomain}.${config.shb.authelia.domain}";
|
|
|
|
secretFile = <path/to/oidcForgejoSharedSecret>;
|
|
secretFileForAuthelia = <path/to/oidcForgejoSharedSecret>;
|
|
};
|
|
```
|
|
|
|
Passing the `ssl` option will auto-configure nginx to force SSL connections with the given
|
|
certificate.
|
|
|
|
The `shb.foregejo.sso.secretFile` and `shb.forgejo.sso.secretFileForAuthelia` options
|
|
must have the same content. The former is a file that must be owned by the `forgejo` user while
|
|
the latter must be owned by the `authelia` user. I want to avoid needing to define the same secret
|
|
twice with a future secrets SHB block.
|
|
|
|
### Backup {#services-forgejo-usage-backup}
|
|
|
|
Backing up Forgejo using the [Restic block](blocks-restic.html) is done like so:
|
|
|
|
```nix
|
|
shb.restic.instances."forgejo" = config.shb.forgejo.backup // {
|
|
enable = true;
|
|
};
|
|
```
|
|
|
|
The name `"foregjo"` in the `instances` can be anything.
|
|
The `config.shb.forgejo.backup` option provides what directories to backup.
|
|
You can define any number of Restic instances to backup Foregejo multiple times.
|
|
|
|
### Extra Settings {#services-forgejo-usage-extra-settings}
|
|
|
|
Other Forgejo settings can be accessed through the nixpkgs [stock service][].
|
|
|
|
[stock service]: https://search.nixos.org/options?channel=24.05&from=0&size=50&sort=alpha_asc&type=packages&query=services.forgejo
|
|
|
|
## Debug {#services-forgejo-debug}
|
|
|
|
In case of an issue, check the logs for systemd service `forgejo.service`.
|
|
|
|
Enable verbose logging by setting the `shb.forgejo.debug` boolean to `true`.
|
|
|
|
Access the database with `sudo -u forgejo psql`.
|
|
|
|
## Options Reference {#services-forgejo-options}
|
|
|
|
```{=include=} options
|
|
id-prefix: services-forgejo-options-
|
|
list-id: selfhostblocks-service-forgejo-options
|
|
source: @OPTIONS_JSON@
|
|
```
|