Skip to content

docs: add simple architecture diagram and small description #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
import-benjamin merged 3 commits into from
May 8, 2025
Merged

docs: add simple architecture diagram and small description #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43c77c4
docs: add simple architecture diagram and small description
import-benjamin May 8, 2025
e98d24b
fix: update mermaid diagram
import-benjamin May 8, 2025
ec5d6ad
docs: add new disk and junction in diagram
import-benjamin May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
# 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]
junction disksplit

service api(server)[api] in vpn
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.

## prerequisite

Expand Down