diff --git a/README.md b/README.md index bc86aaa..2f55ffa 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,70 @@ -# webcam-streamer +# Install webcam-streamer + +Make sure you have the Raspbian 12 +`lsb_release -a` +``` +No LSB modules are available. +Distributor ID: Raspbian +Description: Raspbian GNU/Linux 12 (bookworm) +Release: 12 +Codename: bookworm +``` + +In your home directory clone the repo +`cd ~` +`git clone https://gitea.virtonline.eu/2HoursProject/webcam-streamer.git` + +Go into the project directory +`cd webcam-streamer` + +Install the `webcam-service` systemd service file +`sudo cp webcam-streamer.service /etc/systemd/system/` + +Install the configuration file +`sudo cp webcam-streamer /etc/default/` + +Reload systemd manager configuration +`sudo systemctl daemon-reload` + +Start the `webcam-service` service +`sudo systemctl start webcam-service` + +See the logs of the service (you might want to wait a bit) +`journalctl -fu webcam-service` + +Enable the `webcam-service` service to run at boot time +`sudo systemctl enable webcam-service` + +Stop the `webcam-service` service +`sudo systemctl stop webcam-service` + +Adjust the configration and restart the service +`sudo nano /etc/default/webcam-streamer` +`sudo systemctl restart webcam-service` + +# Install webcam-cleanup + +If you want to periodically remove older video files + +Install the `webcam-cleanup` systemd service file +`sudo cp webcam-cleanup.service /etc/systemd/system/` + +Install the `webcam-cleanup` systemd timer file +`sudo cp webcam-cleanup.timer /etc/systemd/system/` + +Reload systemd manager configuration +`sudo systemctl daemon-reload` + +Adjust the configration (it is the same file as for the `webcam-service`) and start the timer +`sudo nano /etc/default/webcam-streamer` +`sudo systemctl start webcam-cleanup.timer` + +List running timers +`systemctl list-timers` + +Enable the `webcam-cleanup` timer to run at boot time +`sudo systemctl enable webcam-cleanup.timer` + +See the logs of the `webcam-cleanup` service +`journalctl -fu webcam-cleanup`