Skip to content

Commit d2a5e79

Browse files
committedJan 6, 2025··
docs: fix readme for dockerhub
1 parent ed0fa2c commit d2a5e79

File tree

1 file changed

+43
-40
lines changed

1 file changed

+43
-40
lines changed
 

‎README.md

+43-40
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ A lightweight solution for motion detection and video streaming on Raspberry Pi,
1515
- RESTful API and webhook events
1616

1717
<div align="center">
18-
<img src="docs/screenshot.png" alt="Screenshot" style="width:100%; height:auto;">
18+
<img src="https://raw.githubusercontent.com/j3ko/motionberry/main/docs/screenshot.png" alt="Screenshot" style="width:100%; height:auto;">
1919
</div>
2020

2121

@@ -27,19 +27,21 @@ A lightweight solution for motion detection and video streaming on Raspberry Pi,
2727

2828
## Docker installation
2929
To install Motionberry using Docker on your Raspberry Pi, follow these steps:
30-
1. Install [Docker](https://docs.docker.com/engine/install/debian/)
31-
1. Run the following command to deploy Motionberry:
32-
```bash
33-
docker run --name motionberry \
34-
--privileged \
35-
-e PUID 1000 \
36-
-e PGID 1000 \
37-
-v <path to config.yml>:/motionberry/config \
38-
-v <path to capture directory>:/motionberry/captures \
39-
-v /run/udev:/run/udev:ro \
40-
-p 5000:5000 \
41-
j3ko/motionberry:latest
42-
```
30+
31+
1\. Install [Docker](https://docs.docker.com/engine/install/debian/)
32+
33+
2\. Run the following command to deploy Motionberry:
34+
```bash
35+
docker run --name motionberry \
36+
--privileged \
37+
-e PUID 1000 \
38+
-e PGID 1000 \
39+
-v <path to config.yml>:/motionberry/config \
40+
-v <path to capture directory>:/motionberry/captures \
41+
-v /run/udev:/run/udev:ro \
42+
-p 5000:5000 \
43+
j3ko/motionberry:latest
44+
```
4345

4446
Explanation of Options:
4547

@@ -54,33 +56,34 @@ Replace `<path to config.yml>` and `<path to capture directory>` with appropriat
5456

5557
## Bare metal installation
5658
To install and run Motionberry natively on your Raspberry Pi, follow these steps:
57-
1. Install the required libraries:
58-
```bash
59-
sudo apt install -y --no-install-recommends \
60-
git \
61-
ffmpeg \
62-
python3-dev \
63-
python3-venv \
64-
python3-pip \
65-
python3-numpy \
66-
python3-picamera2
67-
```
68-
1. Clone the repository:
69-
```bash
59+
60+
1\. Install the required libraries:
61+
```bash
62+
sudo apt install -y --no-install-recommends \
63+
git \
64+
ffmpeg \
65+
python3-dev \
66+
python3-venv \
67+
python3-pip \
68+
python3-numpy \
69+
python3-picamera2
70+
```
71+
2\. Clone the repository:
72+
```bash
7073
git clone https://github.com/j3ko/motionberry.git
71-
```
72-
1. Set up a virtual environment:
73-
```
74-
cd motionberry
75-
python3 -m venv --system-site-packages .venv
76-
. .venv/bin/activate
77-
pip install --upgrade pip
78-
pip install .
79-
```
80-
1. Run the application:
81-
```bash
82-
python run.py
83-
```
74+
```
75+
3\. Set up a virtual environment:
76+
```bash
77+
cd motionberry
78+
python3 -m venv --system-site-packages .venv
79+
. .venv/bin/activate
80+
pip install --upgrade pip
81+
pip install .
82+
```
83+
4\. Run the application:
84+
```bash
85+
python run.py
86+
```
8487

8588
## Configuration
8689

0 commit comments

Comments
 (0)
Please sign in to comment.