about summary refs log tree commit diff
path: root/nixos/doc
diff options
context:
space:
mode:
authorAdithya Nair <adtya@adtya.xyz>2023-12-15 15:43:45 +0530
committerAdithya Nair <adtya@adtya.xyz>2024-01-18 21:37:40 +0530
commit8b5644684e27ebaf1add58753544d2ab4e34b9ab (patch)
treede994f697f4823bb5199aa835b26cd0b033af6b9 /nixos/doc
parentaaae35a64e9f96cf0dd87392e39f5bf881add08c (diff)
downloadnixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar.gz
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar.bz2
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar.lz
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar.xz
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.tar.zst
nixlib-8b5644684e27ebaf1add58753544d2ab4e34b9ab.zip
nixos/frp: use toml configFile
According to upstream, the INI configuration file is deprecated and
TOML/YAML/JSON is recommended.
Link: https://github.com/fatedier/frp/tree/dev#configuration-files
Diffstat (limited to 'nixos/doc')
-rw-r--r--nixos/doc/manual/release-notes/rl-2405.section.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/nixos/doc/manual/release-notes/rl-2405.section.md b/nixos/doc/manual/release-notes/rl-2405.section.md
index ae9352e9a921..9e8ef49783ca 100644
--- a/nixos/doc/manual/release-notes/rl-2405.section.md
+++ b/nixos/doc/manual/release-notes/rl-2405.section.md
@@ -67,6 +67,12 @@ The pre-existing [services.ankisyncd](#opt-services.ankisyncd.enable) has been m
 
 - The legacy and long deprecated systemd target `network-interfaces.target` has been removed. Use `network.target` instead.
 
+- `services.frp.settings` now generates the frp configuration file in TOML format as [recommended by upstream](https://github.com/fatedier/frp#configuration-files), instead of the legacy INI format. This has also introduced other changes in the configuration file structure and options.
+  - The `settings.common` section in the configuration is no longer valid and all the options form inside it now goes directly under `settings`.
+  - The `_` separating words in the configuration options is removed so the options are now in camel case. For example: `server_addr` becomes `serverAddr`, `server_port` becomes `serverPort` etc.
+  - Proxies are now defined with a new option `settings.proxies` which takes a list of proxies.
+  - Consult the [upstream documentation](https://github.com/fatedier/frp#example-usage) for more details on the changes.
+
 - `mkosi` was updated to v20. Parts of the user interface have changed. Consult the
   release notes of [v19](https://github.com/systemd/mkosi/releases/tag/v19) and
   [v20](https://github.com/systemd/mkosi/releases/tag/v20) for a list of changes.