Sylk

programs.sylk.enable

Whether to enable Sylk.

Type:

boolean

Default:

false

Declared in:

projects/Sylk/programs/sylk/module.nix

programs.sylk.package

The sylk package to use.

Type:

package

Default:

pkgs.sylk

Declared in:

projects/Sylk/programs/sylk/module.nix

Notes:

Missing update script An update script is required for automatically tracking the latest release.

services.sylkserver.debug

Whether to enable verbose logging.

Type:

boolean

Default:

false

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.enable

Whether to enable the SylkServer SIP/XMPP/WebRTC Application Server.

Type:

boolean

Default:

false

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.group

Group under which SylkServer runs.

Type:

non-empty string

Default:

"sylkserver"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.openFirewall

Whether to open ports in the firewall for SylkServer.

Type:

boolean

Default:

false

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.package

The sylkserver package to use.

Type:

package

Default:

pkgs.sylkserver

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings

SylkServer configuration files.

Type:

submodule

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.auth

Authentication configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.conference

Conference application configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.conference.Conference.file_transfer_dir

Directory for storing files transferred to rooms.

Type:

absolute path

Default:

"/var/lib/sylkserver/file_transfer"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.conference.Conference.screensharing_images_dir

Directory where images used by the Screen Sharing functionality will be stored.

Type:

absolute path

Default:

"/var/lib/sylkserver/screensharing_images"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config

Main SylkServer configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.RTP.port_range

Port range for RTP.

Type:

string

Default:

"50000:50500"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.SIP.local_ip

Local IP address for SIP.

Type:

string

Default:

"127.0.0.1"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.SIP.local_tcp_port

TCP port for SIP.

Type:

16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

5060

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.SIP.local_tls_port

TLS port for SIP.

Type:

16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

5061

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.SIP.local_udp_port

UDP port for SIP.

Type:

16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

5060

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.Server.ca_file

Path to the Certificate Authority file for TLS.

Type:

absolute path

Default:

"${config.services.sylkserver.package}/share/sylkserver/tls/ca.crt"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.Server.certificate

Path to the server certificate file for TLS.

Type:

absolute path

Default:

"${config.services.sylkserver.package}/share/sylkserver/tls/default.crt"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.Server.log_level

Log level.

Type:

one of "debug", "info", "warning", "error", "critical"

Default:

"info"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.Server.spool_dir

Directory for files created by the server, excluding logs.

Type:

absolute path

Default:

"/var/lib/sylkserver"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.Server.trace_dir

Directory for trace logs.

Type:

absolute path

Default:

"/var/log/sylkserver"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.config.WebServer.local_port

Port for the web server.

Type:

16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

10888

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.ircconference

IRC conference configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.playback

Playback application configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.webrtcgateway

WebRTC gateway configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.xmppgateway

XMPP gateway configuration.

Type:

open submodule of attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default:

{ }

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.xmppgateway.general.ca_file

Path to the Certificate Authority file for TLS.

Type:

absolute path

Default:

"${config.services.sylkserver.package}/share/sylkserver/tls/ca.crt"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.xmppgateway.general.certificate

Path to the server certificate file for TLS.

Type:

absolute path

Default:

"${config.services.sylkserver.package}/share/sylkserver/tls/default.crt"

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.settings.xmppgateway.general.local_port

Port for XMPP.

Type:

16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default:

5269

Declared in:

projects/Sylk/services/sylkserver/module

services.sylkserver.user

User account under which SylkServer runs.

Type:

non-empty string

Default:

"sylkserver"

Declared in:

projects/Sylk/services/sylkserver/module

{ ... }:

{
  programs.sylk.enable = true;
}

Declared in: projects/Sylk/programs/sylk/examples/basic.nix

{ ... }:

{
  services.sylkserver.enable = true;
}

Declared in: projects/Sylk/services/sylkserver/examples/basic.nix