This repository was archived by the owner on Feb 2, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Add public, logFile and preset flags #14
Open
muItilingualism
wants to merge
8
commits into
aidalgol:main
Choose a base branch
from
muItilingualism:public-flag
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
8361a16
Add public flag option
muItilingualism 0d3b29d
Add logFile flag
muItilingualism 3a68986
Add preset flag
muItilingualism 83a4001
Merge branch 'aidalgol:main' into public-flag
muItilingualism 90b20c6
Fix missing parentheses
muItilingualism 5d086a3
Fix syntax error
muItilingualism 42c41cd
Fix syntax error
muItilingualism 3f2ff79
Add better logFile example and update doc
muItilingualism File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,6 +61,43 @@ in { | |
| description = lib.mdDoc "Whether to open ports in the firewall."; | ||
| }; | ||
|
|
||
| public = lib.mkOption { | ||
| type = lib.types.bool; | ||
| default = true; | ||
| description = lib.mdDoc '' | ||
| Toggles visibility on the Steam server & community lists. | ||
|
|
||
| When not set, defaults to true (visible). | ||
| Set to false to make the server private. | ||
| ''; | ||
| }; | ||
|
|
||
| logFile = lib.mkOption { | ||
| type = with lib.types; nullOr str; | ||
| default = null; | ||
| example = "/var/lib/valheim/log/valheim-server.log"; | ||
| description = lib.mdDoc '' | ||
| The path where the server log file will be saved. | ||
|
|
||
| When set, this will redirect all logs from stdout to the specified path. | ||
| This means that the logs will not be captured by systemd's journal. | ||
| Leave this option unset to keep console logging enabled. | ||
|
|
||
| Make sure the valheim user has write access to the specified directory, otherwise | ||
| the valheim service fail to start and exit. | ||
| ''; | ||
| }; | ||
|
|
||
| preset = lib.mkOption { | ||
| type = with lib.types; nullOr str; | ||
| default = null; | ||
| example = "hardcore"; | ||
| description = lib.mdDoc '' | ||
| The preset world modifier, valid options are | ||
| "easy", "hard", "hardcore", "casual", "hammer" and "immersive". | ||
| ''; | ||
| }; | ||
|
Comment on lines
+91
to
+99
Owner
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Regarding your comment about using an enum type, you would change the type from Reference: NixOS Manual |
||
|
|
||
| password = lib.mkOption { | ||
| type = lib.types.str; | ||
| default = ""; | ||
|
|
@@ -277,8 +314,11 @@ in { | |
| ++ [ | ||
| "-port \"${builtins.toString cfg.port}\"" | ||
| "-password \"${cfg.password}\"" | ||
| "-public ${if cfg.public then "1" else "0"}" | ||
| ] | ||
| ++ (lib.lists.optional cfg.crossplay "-crossplay")); | ||
| ++ (lib.lists.optional cfg.crossplay "-crossplay") | ||
| ++ (lib.lists.optional (cfg.logFile != null) "-logFile \"${cfg.logFile}\"") | ||
| ++ (lib.lists.optional (cfg.preset != null) "-preset \"${cfg.preset}\"")); | ||
| }; | ||
| }; | ||
| }; | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think
-logFileis there because upstream expects you to run it using their wrapper script, from the commandline, where the log output will just go to your terminal scrollback buffer. The NixOS module provided by this flake instead runs it using systemd. Telling the underlying program to log to a file instead of standard out/error somewhat goes against the purpose of running as a systemd service, so I would rather not expose that function.