Home

tsnet-serve-nix @main - refs - log -
-
https://git.jolheiser.com/tsnet-serve-nix.git
tsnet-serve flake, package, and module
tree log patch
chore: README and LICENSE Signed-off-by: jolheiser <git@jolheiser.com>
Signature
-----BEGIN SSH SIGNATURE----- U1NIU0lHAAAAAQAAADMAAAALc3NoLWVkMjU1MTkAAAAgBTEvCQk6VqUAdN2RuH6bj1dNkY oOpbPWj+jw4ua1B1cAAAADZ2l0AAAAAAAAAAZzaGE1MTIAAABTAAAAC3NzaC1lZDI1NTE5 AAAAQA/ebnX6lIg/cG69ElBbnktcHndJJUJ99sF4LbfBykVX9ONfWrxS5Lw7SJUkS+e3hE PnpWuf+LWl+Y0ltmu9tgc= -----END SSH SIGNATURE-----
jolheiser <git@jolheiser.com>
4 months ago
2 changed files, 55 additions(+), 0 deletions(-)
I LICENSE
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..25407bbcbaf75f5fdc903b41d51d1db013d2e9b5
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2024 John Olheiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
I README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..44663dcbea73885283ee51a5f4db7584b5e65b28
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+# tsnet-serve nix
+
+A flake, package, and module for [tsnet-serve](https://github.com/shayne/tsnet-serve).
+
+## Usage
+
+As a flake:
+
+```nix
+tsnet-serve.url = "git+https://git.jolheiser.com/tsnet-serve-nix.git";
+# ...
+imports = [inputs.tsnet-serve.nixosModules.default];
+```
+
+[Module](./module/default.nix):
+
+```nix
+{
+  services.tsnet-serve.instances = {
+    "myapp" = {
+      enable = true;
+      backend = "http://127.0.0.1:XXXX";
+      authKey = "<one-time auth key>"; # https://login.tailscale.com/admin/settings/keys
+    };
+    "otherapp" = {
+      // ...
+    };
+  };
+}
+```
+
+The module still has a few TODOs but should generally work. I'm already using it in a server config successfully.
+
+## License
+
+[MIT](LICENSE)