Skip to content

Commit 1b5f24f

Browse files
committed
add installation instructions
1 parent 3bc1c84 commit 1b5f24f

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed
3.73 MB
Loading

docs/04_ImSwitch/ImSwitchDocker2.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,30 @@ ImSwitch is a modular Python application installed inside a Docker container. Th
1111
- Setting up FastAPI to expose a REST API interface for remote control.
1212
- Running a React app on top of the REST API for web-based control.
1313

14-
### One-Step Installation
14+
![](./IMAGES/ImSwitchDocker.png)
15+
16+
### One-Step Installation (Raspi + Debian?)
1517

1618
For Debian-based systems (Raspberry Pi and others), there is a one-step installation script that installs Docker, camera drivers, and pulls the Docker container for ImSwitch:
1719

1820
Repository: [openUC2/ImSwitchDockerInstall](https://github.com/openUC2/ImSwitchDockerInstall)
1921
Script: `install_all.sh` installs everything you need.
2022

23+
#### Two-step installation (most other cases)
24+
25+
Pull the docker-container and run it
26+
27+
```bash
28+
docker pull ghcr.io/openuc2/imswitch-noqt-x64:latest
29+
sudo docker run -it --rm -p 8001:8001 -p 2222:22 -e HEADLESS=1 -e HTTP_PORT=8001 -e CONFIG_FILE=example_uc2_hik_flowstop.json -e UPDATE_GIT=0 -e UPDATE_CONFIG=0 --privileged ghcr.io/openuc2/imswitch-noqt-x64:latest
30+
```
31+
32+
More information about this here:
33+
https://openuc2.github.io/docs/ImSwitch/ImSwitchDocker#docker-quick-start
34+
35+
36+
37+
2138
### Building the Docker Image
2239

2340
ImSwitch and UC2-REST are cloned and installed into the Docker image directly from the latest commits. During each build, the Git archives are fetched again, ensuring the installation is up-to-date without starting from scratch.

0 commit comments

Comments
 (0)