From 43c77c4972fdfd63a5de8f6b1018fc794b46f47d Mon Sep 17 00:00:00 2001 From: Benjamin <8467845+import-benjamin@users.noreply.github.com> Date: Thu, 8 May 2025 10:54:04 +0200 Subject: [PATCH 1/3] docs: add simple architecture diagram and small description --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 83d6ec9..fcff9fa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # phantom -stream video from usb device over the web +Stream video from usb device over the web. +It is about turning an old Raspberry Pi, with a video device (USB, PCI, etc.), into a home camera. + +```mermaid +architecture-beta + group vpn(cloud)[Private network (using vpn like tailscale)] + service api(server)[api] in vpn + service disk1(disk)[Storage] in api + disk1:T -- B:api +``` + +Once installed, you should be able to connect to your server through your VPN and stream from your video device. ## prerequisite From e98d24b497bac3d90531301bdd79fcefc6003500 Mon Sep 17 00:00:00 2001 From: Benjamin <8467845+import-benjamin@users.noreply.github.com> Date: Thu, 8 May 2025 10:55:54 +0200 Subject: [PATCH 2/3] fix: update mermaid diagram --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index fcff9fa..ab5f7ed 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ It is about turning an old Raspberry Pi, with a video device (USB, PCI, etc.), i ```mermaid architecture-beta - group vpn(cloud)[Private network (using vpn like tailscale)] + group vpn(cloud)[Private network] service api(server)[api] in vpn - service disk1(disk)[Storage] in api + service disk1(disk)[Storage] in vpn disk1:T -- B:api ``` From ec5d6ad705abfc0cf96ea9ad79f6a0d92645d0ba Mon Sep 17 00:00:00 2001 From: Benjamin <8467845+import-benjamin@users.noreply.github.com> Date: Thu, 8 May 2025 11:00:15 +0200 Subject: [PATCH 3/3] docs: add new disk and junction in diagram --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab5f7ed..ce0c4e8 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,15 @@ It is about turning an old Raspberry Pi, with a video device (USB, PCI, etc.), i ```mermaid architecture-beta group vpn(cloud)[Private network] + junction disksplit + service api(server)[api] in vpn - service disk1(disk)[Storage] in vpn - disk1:T -- B:api + service os(disk)[System Storage] in vpn + service storage(disk)[Video Storage] in vpn + + api:R -- L:disksplit + os:B -- T:disksplit + storage:T -- B:disksplit ``` Once installed, you should be able to connect to your server through your VPN and stream from your video device.