From 349181dbe1fc1ae13d31f705eb89d44ed4b16152 Mon Sep 17 00:00:00 2001 From: Fredrik Baberg Date: Thu, 7 Jul 2022 19:39:26 +0200 Subject: [PATCH] Add aioRTC (#1) --- .github/workflows/camera-aiortc.yml | 54 +++++++++++ camera-rtc/DOCS.md | 4 + camera-rtc/Dockerfile | 30 ++++++ camera-rtc/README.md | 3 + camera-rtc/build.yaml | 6 ++ camera-rtc/config.yaml | 21 ++++ camera-rtc/rootfs/etc/cont-init.d/nginx.sh | 13 +++ .../rootfs/etc/nginx/includes/mime.types | 96 +++++++++++++++++++ .../etc/nginx/includes/proxy_params.conf | 15 +++ .../etc/nginx/includes/server_params.conf | 6 ++ .../rootfs/etc/nginx/includes/ssl_params.conf | 8 ++ .../rootfs/etc/nginx/includes/upstream.conf | 3 + camera-rtc/rootfs/etc/nginx/nginx.conf | 44 +++++++++ camera-rtc/rootfs/etc/nginx/servers/.gitkeep | 0 .../rootfs/etc/nginx/templates/direct.gtpl | 21 ++++ .../rootfs/etc/nginx/templates/ingress.gtpl | 13 +++ .../rootfs/etc/services.d/aiortc/finish | 9 ++ camera-rtc/rootfs/etc/services.d/aiortc/run | 15 +++ camera-rtc/rootfs/etc/services.d/nginx/finish | 9 ++ camera-rtc/rootfs/etc/services.d/nginx/run | 11 +++ 20 files changed, 381 insertions(+) create mode 100644 .github/workflows/camera-aiortc.yml create mode 100644 camera-rtc/DOCS.md create mode 100644 camera-rtc/Dockerfile create mode 100644 camera-rtc/README.md create mode 100644 camera-rtc/build.yaml create mode 100644 camera-rtc/config.yaml create mode 100644 camera-rtc/rootfs/etc/cont-init.d/nginx.sh create mode 100644 camera-rtc/rootfs/etc/nginx/includes/mime.types create mode 100644 camera-rtc/rootfs/etc/nginx/includes/proxy_params.conf create mode 100644 camera-rtc/rootfs/etc/nginx/includes/server_params.conf create mode 100644 camera-rtc/rootfs/etc/nginx/includes/ssl_params.conf create mode 100644 camera-rtc/rootfs/etc/nginx/includes/upstream.conf create mode 100644 camera-rtc/rootfs/etc/nginx/nginx.conf create mode 100644 camera-rtc/rootfs/etc/nginx/servers/.gitkeep create mode 100644 camera-rtc/rootfs/etc/nginx/templates/direct.gtpl create mode 100644 camera-rtc/rootfs/etc/nginx/templates/ingress.gtpl create mode 100644 camera-rtc/rootfs/etc/services.d/aiortc/finish create mode 100644 camera-rtc/rootfs/etc/services.d/aiortc/run create mode 100644 camera-rtc/rootfs/etc/services.d/nginx/finish create mode 100644 camera-rtc/rootfs/etc/services.d/nginx/run diff --git a/.github/workflows/camera-aiortc.yml b/.github/workflows/camera-aiortc.yml new file mode 100644 index 0000000..d5fc22b --- /dev/null +++ b/.github/workflows/camera-aiortc.yml @@ -0,0 +1,54 @@ +name: camera-aiortc manual build + +on: + workflow_dispatch: + +jobs: + build: + runs-on: ubuntu-latest + name: Build ${{ matrix.arch }} ${{ matrix.addon }} add-on + strategy: + matrix: + addon: ["camera-rtc"] + arch: ["aarch64", "amd64", "armhf", "armv7", "i386"] + steps: + - name: Check out the repository + uses: actions/checkout@v3 + + - name: Get information + id: info + uses: home-assistant/actions/helpers/info@master + with: + path: "./${{ matrix.addon }}" + + - name: Check if add-on should be built + id: check + run: | + if [[ "${{ steps.info.outputs.architectures }}" =~ ${{ matrix.arch }} ]]; then + echo "::set-output name=build_arch::true"; + echo "::set-output name=image::$(echo ${{ steps.info.outputs.image }} | cut -d'/' -f3)"; + else + echo "${{ matrix.arch }} is not a valid arch for ${{ matrix.addon }}, skipping build"; + echo "::set-output name=build_arch::false"; + fi + + - name: Login to GitHub Container Registry + if: env.BUILD_ARGS != '--test' + uses: docker/login-action@v2.0.0 + with: + registry: ghcr.io + username: ${{ github.repository_owner }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Build ${{ matrix.addon }} add-on + if: steps.check.outputs.build_arch == 'true' + uses: home-assistant/builder@2022.03.1 + with: + args: | + ${{ env.BUILD_ARGS }} \ + --${{ matrix.arch }} \ + --target /data/${{ matrix.addon }} \ + --image "${{ steps.check.outputs.image }}" \ + --docker-hub "ghcr.io/${{ github.repository_owner }}" \ + --addon \ + --docker-hub-check diff --git a/camera-rtc/DOCS.md b/camera-rtc/DOCS.md new file mode 100644 index 0000000..c840e05 --- /dev/null +++ b/camera-rtc/DOCS.md @@ -0,0 +1,4 @@ +# Documentation + +## Configuration + diff --git a/camera-rtc/Dockerfile b/camera-rtc/Dockerfile new file mode 100644 index 0000000..8b7e3c4 --- /dev/null +++ b/camera-rtc/Dockerfile @@ -0,0 +1,30 @@ +ARG BUILD_FROM="ghcr.io/home-assistant/amd64-base-debian:bullseye" +FROM ${BUILD_FROM} + +ENV PIP_FLAGS="--no-cache-dir" + +# Install dependencies +RUN apt update && \ + apt install -y \ + --no-install-recommends \ + python3-minimal \ + nginx \ + python3-pip \ + python3-dev \ + git \ + gcc \ + && pip install ${PIP_FLAGS} aiohttp aiortc \ + && git clone https://github.com/aiortc/aiortc \ + && apt remove -y \ + python3-dev \ + git \ + gcc \ + && apt -y autoremove \ + && apt clean + +# Copy root filesystem +COPY rootfs / + +# Make files executable +RUN chmod +x /etc/cont-init.d/*.sh +RUN chmod +x /etc/services.d/*/* diff --git a/camera-rtc/README.md b/camera-rtc/README.md new file mode 100644 index 0000000..3556dfa --- /dev/null +++ b/camera-rtc/README.md @@ -0,0 +1,3 @@ +# Camera-RTC + +Camera addon with support for WebRTC. diff --git a/camera-rtc/build.yaml b/camera-rtc/build.yaml new file mode 100644 index 0000000..5523b9b --- /dev/null +++ b/camera-rtc/build.yaml @@ -0,0 +1,6 @@ +build_from: + aarch64: ghcr.io/home-assistant/aarch64-base-debian:bullseye + amd64: ghcr.io/home-assistant/amd64-base-debian:bullseye + armhf: ghcr.io/home-assistant/armhf-base-debian:bullseye + armv7: ghcr.io/home-assistant/armv7-base-debian:bullseye + i386: ghcr.io/home-assistant/i386-base-debian:bullseye diff --git a/camera-rtc/config.yaml b/camera-rtc/config.yaml new file mode 100644 index 0000000..56d4bf2 --- /dev/null +++ b/camera-rtc/config.yaml @@ -0,0 +1,21 @@ +name: "Camera-RTC" +version: "2022.7.011" +slug: "camera-aiortc" +description: "Camera stream with support for WebRTC." +url: "https://github.com/fredrikbaberg/3dprinter-addons/tree/main/camera-rtc" +ingress: true +ingress_stream: true +panel_icon: mdi:camera +arch: + - aarch64 + - amd64 + - armhf + - armv7 + - i386 +init: false +video: true +usb: true +options: + webrtc_arguments: '' +schema: + webrtc_arguments: str diff --git a/camera-rtc/rootfs/etc/cont-init.d/nginx.sh b/camera-rtc/rootfs/etc/cont-init.d/nginx.sh new file mode 100644 index 0000000..74007ba --- /dev/null +++ b/camera-rtc/rootfs/etc/cont-init.d/nginx.sh @@ -0,0 +1,13 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Add-on: aiortc +# Configures NGINX for use with aiortc +# ============================================================================== + +# Generate Ingress configuration +bashio::var.json \ + interface "$(bashio::addon.ip_address)" \ + port "^$(bashio::addon.ingress_port)" \ + | tempio \ + -template /etc/nginx/templates/ingress.gtpl \ + -out /etc/nginx/servers/ingress.conf diff --git a/camera-rtc/rootfs/etc/nginx/includes/mime.types b/camera-rtc/rootfs/etc/nginx/includes/mime.types new file mode 100644 index 0000000..c230212 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/includes/mime.types @@ -0,0 +1,96 @@ +types { + text/html html htm shtml; + text/css css; + text/xml xml; + image/gif gif; + image/jpeg jpeg jpg; + application/javascript js; + application/atom+xml atom; + application/rss+xml rss; + + text/mathml mml; + text/plain txt; + text/vnd.sun.j2me.app-descriptor jad; + text/vnd.wap.wml wml; + text/x-component htc; + + image/png png; + image/svg+xml svg svgz; + image/tiff tif tiff; + image/vnd.wap.wbmp wbmp; + image/webp webp; + image/x-icon ico; + image/x-jng jng; + image/x-ms-bmp bmp; + + font/woff woff; + font/woff2 woff2; + + application/java-archive jar war ear; + application/json json; + application/mac-binhex40 hqx; + application/msword doc; + application/pdf pdf; + application/postscript ps eps ai; + application/rtf rtf; + application/vnd.apple.mpegurl m3u8; + application/vnd.google-earth.kml+xml kml; + application/vnd.google-earth.kmz kmz; + application/vnd.ms-excel xls; + application/vnd.ms-fontobject eot; + application/vnd.ms-powerpoint ppt; + application/vnd.oasis.opendocument.graphics odg; + application/vnd.oasis.opendocument.presentation odp; + application/vnd.oasis.opendocument.spreadsheet ods; + application/vnd.oasis.opendocument.text odt; + application/vnd.openxmlformats-officedocument.presentationml.presentation + pptx; + application/vnd.openxmlformats-officedocument.spreadsheetml.sheet + xlsx; + application/vnd.openxmlformats-officedocument.wordprocessingml.document + docx; + application/vnd.wap.wmlc wmlc; + application/x-7z-compressed 7z; + application/x-cocoa cco; + application/x-java-archive-diff jardiff; + application/x-java-jnlp-file jnlp; + application/x-makeself run; + application/x-perl pl pm; + application/x-pilot prc pdb; + application/x-rar-compressed rar; + application/x-redhat-package-manager rpm; + application/x-sea sea; + application/x-shockwave-flash swf; + application/x-stuffit sit; + application/x-tcl tcl tk; + application/x-x509-ca-cert der pem crt; + application/x-xpinstall xpi; + application/xhtml+xml xhtml; + application/xspf+xml xspf; + application/zip zip; + + application/octet-stream bin exe dll; + application/octet-stream deb; + application/octet-stream dmg; + application/octet-stream iso img; + application/octet-stream msi msp msm; + + audio/midi mid midi kar; + audio/mpeg mp3; + audio/ogg ogg; + audio/x-m4a m4a; + audio/x-realaudio ra; + + video/3gpp 3gpp 3gp; + video/mp2t ts; + video/mp4 mp4; + video/mpeg mpeg mpg; + video/quicktime mov; + video/webm webm; + video/x-flv flv; + video/x-m4v m4v; + video/x-mng mng; + video/x-ms-asf asx asf; + video/x-ms-wmv wmv; + video/x-msvideo avi; +} \ No newline at end of file diff --git a/camera-rtc/rootfs/etc/nginx/includes/proxy_params.conf b/camera-rtc/rootfs/etc/nginx/includes/proxy_params.conf new file mode 100644 index 0000000..1990d49 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/includes/proxy_params.conf @@ -0,0 +1,15 @@ +proxy_http_version 1.1; +proxy_ignore_client_abort off; +proxy_read_timeout 86400s; +proxy_redirect off; +proxy_send_timeout 86400s; +proxy_max_temp_file_size 0; + +proxy_set_header Accept-Encoding ""; +proxy_set_header Connection $connection_upgrade; +proxy_set_header Host $http_host; +proxy_set_header Upgrade $http_upgrade; +proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; +proxy_set_header X-Forwarded-Proto $scheme; +proxy_set_header X-NginX-Proxy true; +proxy_set_header X-Real-IP $remote_addr; diff --git a/camera-rtc/rootfs/etc/nginx/includes/server_params.conf b/camera-rtc/rootfs/etc/nginx/includes/server_params.conf new file mode 100644 index 0000000..09c0654 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/includes/server_params.conf @@ -0,0 +1,6 @@ +root /dev/null; +server_name $hostname; + +add_header X-Content-Type-Options nosniff; +add_header X-XSS-Protection "1; mode=block"; +add_header X-Robots-Tag none; diff --git a/camera-rtc/rootfs/etc/nginx/includes/ssl_params.conf b/camera-rtc/rootfs/etc/nginx/includes/ssl_params.conf new file mode 100644 index 0000000..e6789cb --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/includes/ssl_params.conf @@ -0,0 +1,8 @@ +ssl_protocols TLSv1.2 TLSv1.3; +ssl_prefer_server_ciphers off; +ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384; +ssl_session_timeout 10m; +ssl_session_cache shared:SSL:10m; +ssl_session_tickets off; +ssl_stapling on; +ssl_stapling_verify on; diff --git a/camera-rtc/rootfs/etc/nginx/includes/upstream.conf b/camera-rtc/rootfs/etc/nginx/includes/upstream.conf new file mode 100644 index 0000000..b292326 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/includes/upstream.conf @@ -0,0 +1,3 @@ +upstream backend { + server 127.0.0.1:8080; +} diff --git a/camera-rtc/rootfs/etc/nginx/nginx.conf b/camera-rtc/rootfs/etc/nginx/nginx.conf new file mode 100644 index 0000000..11e15c7 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/nginx.conf @@ -0,0 +1,44 @@ +# Run nginx in foreground. +daemon off; + +# This is run inside Docker. +user root; + +# Pid storage location. +pid /var/run/nginx.pid; + +# Set number of worker processes. +worker_processes 1; + +# Enables the use of JIT for regular expressions to speed-up their processing. +pcre_jit on; + +# Write error log to the add-on log. +error_log /proc/1/fd/1 error; + +# Max num of simultaneous connections by a worker process. +events { + worker_connections 512; +} + +http { + include /etc/nginx/includes/mime.types; + + access_log off; + client_max_body_size 4G; + default_type application/octet-stream; + gzip on; + keepalive_timeout 65; + sendfile on; + server_tokens off; + tcp_nodelay on; + tcp_nopush on; + + map $http_upgrade $connection_upgrade { + default upgrade; + '' close; + } + + include /etc/nginx/includes/upstream.conf; + include /etc/nginx/servers/*.conf; +} diff --git a/camera-rtc/rootfs/etc/nginx/servers/.gitkeep b/camera-rtc/rootfs/etc/nginx/servers/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/camera-rtc/rootfs/etc/nginx/templates/direct.gtpl b/camera-rtc/rootfs/etc/nginx/templates/direct.gtpl new file mode 100644 index 0000000..9bafe03 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/templates/direct.gtpl @@ -0,0 +1,21 @@ +server { + {{ if not .ssl }} + listen {{ .port }} default_server; + {{ else }} + listen {{ .port }} default_server ssl http2; + {{ end }} + + include /etc/nginx/includes/server_params.conf; + include /etc/nginx/includes/proxy_params.conf; + + {{ if .ssl }} + include /etc/nginx/includes/ssl_params.conf; + + ssl_certificate /ssl/{{ .certfile }}; + ssl_certificate_key /ssl/{{ .keyfile }}; + {{ end }} + + location / { + proxy_pass http://backend; + } +} \ No newline at end of file diff --git a/camera-rtc/rootfs/etc/nginx/templates/ingress.gtpl b/camera-rtc/rootfs/etc/nginx/templates/ingress.gtpl new file mode 100644 index 0000000..e216772 --- /dev/null +++ b/camera-rtc/rootfs/etc/nginx/templates/ingress.gtpl @@ -0,0 +1,13 @@ +server { + listen {{ .interface }}:{{ .port }} default_server; + + include /etc/nginx/includes/server_params.conf; + include /etc/nginx/includes/proxy_params.conf; + + location / { + allow 172.30.32.2; + deny all; + + proxy_pass http://backend; + } +} diff --git a/camera-rtc/rootfs/etc/services.d/aiortc/finish b/camera-rtc/rootfs/etc/services.d/aiortc/finish new file mode 100644 index 0000000..45eba64 --- /dev/null +++ b/camera-rtc/rootfs/etc/services.d/aiortc/finish @@ -0,0 +1,9 @@ +#!/usr/bin/execlineb -S0 +# ============================================================================== +# Add-on: aiortc +# Take down the S6 supervision tree when aiortc fails +# ============================================================================== +if -n { s6-test $# -ne 0 } +if -n { s6-test ${1} -eq 256 } + +s6-svscanctl -t /var/run/s6/services diff --git a/camera-rtc/rootfs/etc/services.d/aiortc/run b/camera-rtc/rootfs/etc/services.d/aiortc/run new file mode 100644 index 0000000..5e8882f --- /dev/null +++ b/camera-rtc/rootfs/etc/services.d/aiortc/run @@ -0,0 +1,15 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Add-on: aiortc +# Runs aiortc +# ============================================================================== +declare -a options + +if bashio::config.has_value 'webrtc_arguments'; then + options+="$(bashio::config 'webrtc_arguments')" +fi + +bashio::log.info "Starting aiortc with arguments: '$options'" + +# Run aiortc +exec python3 /aiortc/examples/webcam/webcam.py "${options[@]}" diff --git a/camera-rtc/rootfs/etc/services.d/nginx/finish b/camera-rtc/rootfs/etc/services.d/nginx/finish new file mode 100644 index 0000000..aedec9a --- /dev/null +++ b/camera-rtc/rootfs/etc/services.d/nginx/finish @@ -0,0 +1,9 @@ +#!/usr/bin/execlineb -S0 +# ============================================================================== +# Add-on: aiortc +# Take down the S6 supervision tree when Nginx fails +# ============================================================================== +if -n { s6-test $# -ne 0 } +if -n { s6-test ${1} -eq 256 } + +s6-svscanctl -t /var/run/s6/services diff --git a/camera-rtc/rootfs/etc/services.d/nginx/run b/camera-rtc/rootfs/etc/services.d/nginx/run new file mode 100644 index 0000000..3974b94 --- /dev/null +++ b/camera-rtc/rootfs/etc/services.d/nginx/run @@ -0,0 +1,11 @@ +#!/usr/bin/with-contenv bashio +# ============================================================================== +# Add-on: aiortc +# Runs the Nginx daemon +# ============================================================================== + +# Wait for aiortc web server to be available +bashio::net.wait_for 8080 + +bashio::log.info "Starting NGinx..." +exec nginx \ No newline at end of file