lemmy

Lemmy is an ActivityPub alternative to Reddit

Declared in: projects/lemmy/default.nix

Demo

Implement missing demo

Options

services.lemmy
services.lemmy.adminPasswordFile

File which contains the value of setup.admin_password.

Type:
null or absolute path
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.caddy.enable

Whether to enable exposing lemmy with the caddy reverse proxy.

Type:
boolean
Default:
false
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.database.createLocally

Whether to enable creation of database on the instance.

Type:
boolean
Default:
false
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.database.uri

The connection URI to use. Takes priority over the configuration file if set.

Type:
null or string
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.database.uriFile

File which contains the database uri.

Type:
null or absolute path
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.enable

Whether to enable lemmy a federated alternative to reddit in rust.

Type:
boolean
Default:
false
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.nginx.enable

Whether to enable exposing lemmy with the nginx reverse proxy.

Type:
boolean
Default:
false
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.pictrsApiKeyFile

File which contains the value of pictrs.api_key.

Type:
null or absolute path
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.server.package

The lemmy-server package to use.

Type:
package
Default:
pkgs.lemmy-server
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.settings

Lemmy configuration

Type:
open submodule of (JSON value)
Default:
{ }
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.settings.captcha.difficulty

The difficultly of the captcha to solve.

Type:
one of "easy", "medium", "hard"
Default:
"medium"
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.settings.captcha.enabled

Enable Captcha.

Type:
boolean
Default:
true
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.settings.hostname

The domain name of your instance (eg 'lemmy.ml').

Type:
string
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.settings.port

Port where lemmy should listen for incoming requests.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8536
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.smtpPasswordFile

File which contains the value of email.smtp_password.

Type:
null or absolute path
Default:
null
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.ui.package

The lemmy-ui package to use.

Type:
package
Default:
pkgs.lemmy-ui
Declared in:
nixos/modules/services/web-apps/lemmy.nix
services.lemmy.ui.port

Port where lemmy-ui should listen for incoming requests.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
1234
Declared in:
nixos/modules/services/web-apps/lemmy.nix

Examples

Enable lemmy
{ ... }:

{
  services.lemmy = {
    enable = true;
    ui.port = 3000;
    database.createLocally = true;
    settings = {
      hostname = "http://nixlemmy.com";
      port = 8000;
      setup = {
        admin_username = "admin";
        site_name = "Nix is Awesome Lemmy";
        admin_email = "lemmyadmin@example.com";
      };
    };
    adminPasswordFile = "/etc/lemmy-admin-password.txt";
    nginx.enable = true;
  };
}

Declared in: projects/lemmy/services/lemmy/examples/basic.nix

Metadata

This project is funded by NLnet through these subgrants:

Core
Lemmy-Scale
Entrust
Lemmy-PrivateCommunities
Review
Lemmy
LemmyFed-AP

Related links: