aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorstuebinm2021-02-26 23:15:38 +0100
committerstuebinm2021-02-26 23:15:38 +0100
commit98a6f5a8faf5fb11bbe6775de925e916b454f2ba (patch)
treee7f1e0b18495176a02d84d5f80a4ea4cbc922d64 /README.md
parente3b74e31f5da1685b637578ffd5050dd2bc6fad4 (diff)
added readme
Diffstat (limited to '')
-rw-r--r--README.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4d16679
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Nix files for workadventure
+
+this is based on the [original packages by SuperSandro2000](https://github.com/SuperSandro2000/workadventure-nix)
+and parts of [the fediventure monorepo](https://gitlab.com/fediventure/fediventure/).
+
+The intended usage is to import this into your config and then use it as
+a normal NixOS service, i.e. like so:
+
+```nix
+{config, pkgs, ...}: {
+ imports = [ "${fediventure}/workadventure.nix" ];
+
+ services.workadventure."localhost" = {
+ nginx = {
+ default = true;
+ domain = "localhost";
+ };
+
+ frontend.startRoomUrl = "/_/global/localhost/maps/main.json";
+ commonConfig = {
+ webrtc.stun.url = "stun:coturn.somewhere:3478";
+ webrtc.turn = {
+ url = "turn:coturn.somewhere";
+ user = "turn";
+ password = "TURN_PASSWORD";
+ };
+ jitsi.url = "meet.somewhere.net";
+ };
+ };
+}
+``` \ No newline at end of file