Home Explore Blog CI



nixpkgs

1st chunk of `nixos/modules/services/web-apps/lemmy.md`
6513f8fe993950a2c670582796da14a5312b7259fb109ab4000000010000039b
# Lemmy {#module-services-lemmy}

Lemmy is a federated alternative to reddit in rust.

## Quickstart {#module-services-lemmy-quickstart}

the minimum to start lemmy is

```nix
{
  services.lemmy = {
    enable = true;
    settings = {
      hostname = "lemmy.union.rocks";
      database.createLocally = true;
    };
    caddy.enable = true;
  };
}
```

this will start the backend on port 8536 and the frontend on port 1234.
It will expose your instance with a caddy reverse proxy to the hostname you've provided.
Postgres will be initialized on that same instance automatically.

## Usage {#module-services-lemmy-usage}

On first connection you will be asked to define an admin user.

## Missing {#module-services-lemmy-missing}

- Exposing with nginx is not implemented yet.
- This has been tested using a local database with a unix socket connection. Using different database settings will likely require modifications

Title: Lemmy Module Overview and Quickstart
Summary
This section introduces the Lemmy NixOS module, a federated Reddit alternative. It provides a quickstart configuration example that enables Lemmy with a Caddy reverse proxy and a locally initialized Postgres database. It also highlights current limitations, such as the lack of nginx support and limited testing with non-default database configurations.