haskal
/
dragnpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix docs

This commit is contained in:
xenia 2025-09-11 15:47:18 -04:00
parent 988ab7b6aa
commit 8560bebc33
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -333,23 +333,23 @@ server works, but it will be performed securely, before the server is exposed to
first time. This means you can safely deploy the server to the public internet without worrying
about exposing the "unclaimed" initial server mode, where any user could gain full privileges.
### `services.satisfactory.enable`
#### `services.satisfactory.enable`
enables the satisfactory dedicated server service
### `services.satisfactory.package` (`pkgs.satisfactory-dedicated-server`)
#### `services.satisfactory.package` (`pkgs.satisfactory-dedicated-server`)
the package to use for the service
### `services.satisfactory.directory` (`"/var/lib/satisfactory"`)
#### `services.satisfactory.directory` (`"/var/lib/satisfactory"`)
Directory where Satisfactory Dedicated Server data will be stored
### `services.satisfactory.{user,group}` (`"satisfactory"`)
#### `services.satisfactory.{user,group}` (`"satisfactory"`)
User account and group under which Satisfactory Dedicated Server runs
### `services.satisfactory.useACMEHost` (`null`)
#### `services.satisfactory.useACMEHost` (`null`)
If set, the server will use the ACME-provided TLS certificate for the given host.
@ -357,31 +357,31 @@ Note that this module does not actually provision the specified certificate; you
config (e.g., `services.nginx.virtualHosts.<name>.enableACME = true`) to provision the certificate
using a supported ACME method.
### `services.satisfactory.port` (`7777`)
#### `services.satisfactory.port` (`7777`)
Server port number (TCP/UDP)
This corresponds to the `-Port` command line option.
### `services.satisfactory.reliablePort` (`8888`)
#### `services.satisfactory.reliablePort` (`8888`)
Server reliable port number
This corresponds to the `-ReliablePort` command line option.
### `services.satisfactory.externalReliablePort` (`null`)
#### `services.satisfactory.externalReliablePort` (`null`)
Server reliable port number as seen outside NAT.
This corresponds to the `-ExternalReliablePort` command line option.
### `services.satisfactory.disableSeasonalEvents` (`false`)
#### `services.satisfactory.disableSeasonalEvents` (`false`)
Whether to run the server with seasonal events disabled.
This corresponds to the `-DisableSeasonalEvents` command line option.
### `services.satisfactory.extraIniOptions` (`{}`)
#### `services.satisfactory.extraIniOptions` (`{}`)
Run the server with additional ini configuration values.
@ -396,23 +396,23 @@ This is a nested attribute set of values.
This corresponds to the `-ini` command line option.
### `services.satisfactory.initialSettings`
#### `services.satisfactory.initialSettings`
Settings to apply to the server via the server API on the first run.
### `services.satisfactory.initialSettings.serverName` (`null`)
#### `services.satisfactory.initialSettings.serverName` (`null`)
The name of the server.
If this is provided, `adminPasswordFile` must also be set.
### `services.satisfactory.initialSettings.adminPasswordFile` (`null`)
#### `services.satisfactory.initialSettings.adminPasswordFile` (`null`)
Path to a file containing the initial admin password.
If this is provided, `serverName` must also be set.
### `services.satisfactory.initialSettings.clientPasswordFile` (`null`)
#### `services.satisfactory.initialSettings.clientPasswordFile` (`null`)
Path to a file containing the initial client password. If not set, the server will
not be configured with a client password and will be accessible to any client.