Skip to content

Commit fff3ff1

Browse files
committed
Add Installation Section to Readme
This patch adds an installation section to the readme which contains all installation methods instead of having them scattered all over the readme file.
1 parent 5627cb8 commit fff3ff1

1 file changed

Lines changed: 53 additions & 48 deletions

File tree

README.md

Lines changed: 53 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,66 @@ https://github.com/virtUOS/opencast-camera-control/assets/1008395/a8e37229-f760-
1515

1616
<small><i>(Camera moves when a one minute scheduled recording starts and returns to point at the wall at the end)</i></small>
1717

18-
## Getting started
18+
## Installation
19+
20+
### PIP
21+
22+
We release Opencast Camera Control via [the Python Package Index](https://pypi.org/).
23+
This means you can easily install the tool via pip:
1924

2025
```
2126
❯ pip install opencast-camera-control
2227
❯ opencast-camera-control
2328
```
2429

2530

31+
### RPM Repository
32+
33+
On RHEL 9 like distributions (CentOS Stream, Rocky, Alma, …) you can use the RPM repository to install Opencast Camera Control.
34+
Install the repository by adding a file `/etc/yum.repos.d/opencast-camera-control.repo`:
35+
36+
```ini
37+
[opencast-camera-control]
38+
name = Opencast camera control el$releasever repository
39+
baseurl = https://raw.githubusercontent.com/virtUOS/opencast-camera-control/rpm-el$releasever/
40+
enabled = 1
41+
gpgcheck = 1
42+
gpgkey = https://raw.githubusercontent.com/virtUOS/opencast-camera-control/rpm-el$releasever/opencast-camera-control.key
43+
```
44+
45+
Then activate the EPEL repository and install `opencast-camera-control`:
46+
47+
```
48+
❯ dnf install -y epel-release
49+
❯ dnf install -y opencast-camera-control
50+
```
51+
52+
The RPM packages provide a Systemd unit to run the tool as service:
53+
54+
```
55+
❯ systemctl start opencast-camera-control.service
56+
❯ systemctl enable opencast-camera-control.service
57+
```
58+
59+
60+
## Container
61+
62+
We also provide a container image.
63+
A simple docker compose example would look like this
64+
65+
```yaml
66+
---
67+
services:
68+
camera-control:
69+
image: ghcr.io/virtuos/opencast-camera-control:0.2.0
70+
container_name: opencast-camera-control
71+
ports:
72+
- '8000:8000'
73+
volumes:
74+
- './your_config.yml:/etc/camera-control.yml'
75+
```
76+
77+
2678
## Configuration
2779
2880
Take a look at the [camera-control.yml](camera-control.yml) configuration file.
@@ -81,50 +133,3 @@ agent_calendar_update_time{agent="test_agent"} 1.707571943100096e+09
81133
# TYPE camera_position gauge
82134
camera_position{camera="http://camera-2-panasonic.example.com"} 10.0
83135
```
84-
85-
86-
## RPM Repository
87-
88-
On RHEL 9 like distributions (CentOS Stream, Rocky, Alma, …) you can use the RPM repository to install Opencast Camera Control.
89-
Install the repository by adding a file `/etc/yum.repos.d/opencast-camera-control.repo`:
90-
91-
```ini
92-
[opencast-camera-control]
93-
name = Opencast camera control el$releasever repository
94-
baseurl = https://raw.githubusercontent.com/virtUOS/opencast-camera-control/rpm-el$releasever/
95-
enabled = 1
96-
gpgcheck = 1
97-
gpgkey = https://raw.githubusercontent.com/virtUOS/opencast-camera-control/rpm-el$releasever/opencast-camera-control.key
98-
```
99-
100-
Then activate the EPEL repository and install `opencast-camera-control`:
101-
102-
```
103-
dnf install epel-release
104-
dnf install opencast-camera-control
105-
```
106-
107-
The RPM packages provide a Systemd unit to run the tool as service:
108-
109-
```
110-
systemctl start opencast-camera-control.service
111-
systemctl enable opencast-camera-control.service
112-
```
113-
114-
115-
## Docker
116-
117-
We also provide a container image.
118-
A simple docker compose example would look like this
119-
120-
```yaml
121-
---
122-
version: '3'
123-
services:
124-
app:
125-
image: ghcr.io/virtuos/opencast-camera-control:main
126-
ports:
127-
- '8000:8000'
128-
volumes:
129-
- './your_config.yml:/etc/camera-control.yml'
130-
```

0 commit comments

Comments
 (0)