Skip to content

localsend 🔹

Securely sharing files and messages over a local network without internet connectivity.

Deprecated

The localsend module is deprecated.*

Use 'clanServices/localsend' or a similar successor instead

Categories

Utility

Usage via Inventory

Roles

This module can be used via predefined roles

  • default

Every role has its own configuration options, which are each listed below.

For more information, see the inventory guide.

Example

For example the admin module adds the following options globally to all machines where it is used.

clan.admin.allowedkeys

This means there are two equivalent ways to set the allowedkeys option. Either via a nixos module or via the inventory interface. But it is recommended to keep together imports and config to preserve locality of the module configuration.

clan-core.lib.buildClan {
    inventory.services = {
        admin.me = {
            roles.default.machines = [ "jon" ];
            config.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
        };
    };
};

clan-core.lib.buildClan {
    machines = {
        jon = {
            clan.admin.allowedkeys = [ "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQD..." ];
            imports = [ clanModules.admin ];
        };
    };
};

Options of default role

The following options are available when using the default role.

displayName

The name that localsend will use to display your instance.

Type: null or string

Default:

null

Declared in: clanModules/localsend/roles/default.nix

ipv4Addr

Optional IPv4 address for ZeroTier network.

Type: null or string

Default:

null
Example 
"192.168.56.2/24"

Declared in: clanModules/localsend/roles/default.nix

package

The localsend package to use.

Type: package

Default:

pkgs.localsend

Declared in: clanModules/localsend/roles/default.nix

Usage via Nix

This module can be also imported directly in your nixos configuration. Although it is recommended to use the inventory interface if available.

Some modules are considered 'low-level' or 'expert modules' and are not available via the inventory interface.

{config, lib, inputs, ...}: {
    imports = [ inputs.clan-core.clanModules.localsend ];
    # ...
}

Module Options

The following options are available for this module.

clan.localsend.displayName

The name that localsend will use to display your instance.

Type: null or string

Default:

null

Declared in: clanModules/localsend/roles/default.nix

clan.localsend.ipv4Addr

Optional IPv4 address for ZeroTier network.

Type: null or string

Default:

null
Example 
"192.168.56.2/24"

Declared in: clanModules/localsend/roles/default.nix

clan.localsend.package

The localsend package to use.

Type: package

Default:

pkgs.localsend

Declared in: clanModules/localsend/roles/default.nix