├── .gitignore ├── .env.prod.example ├── bin └── logprefix ├── conf └── supervisord.conf ├── docker-compose.prod.yml ├── Dockerfile ├── .github ├── actions │ └── docker-build │ │ └── action.yml └── workflows │ └── release.yml ├── BUILD_VERSIONS.md ├── README.md ├── receiver.sh └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | ./data/ 2 | .apikey 3 | .env -------------------------------------------------------------------------------- /.env.prod.example: -------------------------------------------------------------------------------- 1 | # Base URL for the API server 2 | # This will be used by the management app to make API calls 3 | APP_URL=http://your.public.ip.address:8080 4 | 5 | # Ports 6 | SRT_PLAYER_PORT=4000 7 | SRT_SENDER_PORT=4001 8 | SLS_STATS_PORT=8080 9 | SRTLA_PORT=5000 10 | SLS_MGNT_PORT=8123 11 | -------------------------------------------------------------------------------- /bin/logprefix: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | # setup fd-3 to point to the original stdout 3 | exec 3>&1 4 | # setup fd-4 to point to the original stderr 5 | exec 4>&2 6 | 7 | # get the prefix from SUPERVISOR_PROCESS_NAME environement variable 8 | printf -v PREFIX "%-10.10s" ${SUPERVISOR_PROCESS_NAME} 9 | 10 | # reassign stdout and stderr to a preprocessed and redirected to the original stdout/stderr (3 and 4) we have create eralier 11 | exec 1> >( perl -ne '$| = 1; print "'"${PREFIX}"' | $_"' >&3) 12 | exec 2> >( perl -ne '$| = 1; print "'"${PREFIX}"' | $_"' >&4) 13 | 14 | # from here on everthing that outputs to stdout/stderr will be go through the perl script 15 | 16 | exec "$@" -------------------------------------------------------------------------------- /conf/supervisord.conf: -------------------------------------------------------------------------------- 1 | [supervisord] 2 | logfile=/var/log/supervisord.log 3 | logfile_maxbytes=10MB 4 | logfile_backups=3 5 | loglevel=error 6 | pidfile=/var/run/supervisord.pid 7 | nodaemon=true 8 | minfds=1024 9 | minprocs=200 10 | childlogdir=/var/log/ 11 | 12 | [supervisorctl] 13 | serverurl=unix:///tmp/supervisor.sock 14 | 15 | [program:sls] 16 | priority=50 17 | autostart=true 18 | autorestart=unexpected 19 | redirect_stderr=true 20 | user=sls 21 | stdout_events_enabled=true 22 | stderr_events_enabled=true 23 | stdout_logfile=/dev/stdout 24 | stdout_logfile_maxbytes=0 25 | stderr_logfile=/dev/stderr 26 | stderr_logfile_maxbytes=0 27 | command=/bin/logprefix /usr/local/bin/sls -c /etc/sls/sls.conf 28 | 29 | [program:srtla] 30 | priority=150 31 | autostart=true 32 | autorestart=unexpected 33 | redirect_stderr=true 34 | user=srtla 35 | stdout_events_enabled=true 36 | stderr_events_enabled=true 37 | stdout_logfile=/dev/stdout 38 | stdout_logfile_maxbytes=0 39 | stderr_logfile=/dev/stderr 40 | stderr_logfile_maxbytes=0 41 | command=/bin/sh -c "sleep 3 && /bin/logprefix /usr/local/bin/srtla_rec --srtla_port=5000 --srt_hostname=localhost --srt_port=4001" 42 | -------------------------------------------------------------------------------- /docker-compose.prod.yml: -------------------------------------------------------------------------------- 1 | services: 2 | sls-management-ui: 3 | image: ghcr.io/openirl/sls-management-ui:latest 4 | container_name: sls-management-ui 5 | restart: unless-stopped 6 | environment: 7 | REACT_APP_BASE_URL: "${APP_URL}" 8 | REACT_APP_SRT_PLAYER_PORT: "${SRT_PLAYER_PORT:-4000}" 9 | REACT_APP_SRT_SENDER_PORT: "${SRT_SENDER_PORT:-4001}" 10 | REACT_APP_SLS_STATS_PORT: "${SLS_STATS_PORT:-8080}" 11 | REACT_APP_SRTLA_PORT: "${SRTLA_PORT:-5000}" 12 | ports: 13 | - "${SLS_MGNT_PORT}:3000" 14 | logging: 15 | driver: "json-file" 16 | options: 17 | max-size: "10m" 18 | max-file: "3" 19 | 20 | receiver: 21 | image: ghcr.io/openirl/srtla-receiver:latest 22 | container_name: srtla-receiver 23 | restart: unless-stopped 24 | ports: 25 | - "${SLS_STATS_PORT}:8080/tcp" 26 | - "${SRTLA_PORT}:5000/udp" 27 | - "${SRT_SENDER_PORT}:4001/udp" 28 | - "${SRT_PLAYER_PORT}:4000/udp" 29 | volumes: 30 | - ./data:/var/lib/sls # Persistent storage for database 31 | logging: 32 | driver: "json-file" 33 | options: 34 | max-size: "10m" 35 | max-file: "3" 36 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # Build arguments that need to be available globally 2 | ARG SRTLA_BRANCH=main 3 | ARG SLS_TAG=latest 4 | 5 | # Builder Stage 6 | FROM alpine:3.20 AS builder 7 | 8 | # Redeclare build argument for this stage 9 | ARG SRTLA_BRANCH 10 | 11 | ENV LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib64 12 | WORKDIR /tmp 13 | 14 | # Install required packages 15 | RUN apk update \ 16 | && apk add --no-cache linux-headers alpine-sdk cmake tcl openssl-dev zlib-dev spdlog spdlog-dev \ 17 | && rm -rf /var/cache/apk/* 18 | 19 | # Clone and build SRTla 20 | RUN git clone -b ${SRTLA_BRANCH} https://github.com/OpenIRL/srtla.git srtla \ 21 | && cd srtla \ 22 | && git submodule update --init --recursive \ 23 | && cmake . \ 24 | && make -j${nproc} 25 | 26 | # SLS Stage 27 | # Redeclare build argument for this stage 28 | ARG SLS_TAG 29 | FROM ghcr.io/openirl/srt-live-server:${SLS_TAG} AS sls-stage 30 | 31 | # Final Stage 32 | FROM alpine:3.20 33 | 34 | ENV LD_LIBRARY_PATH=/lib:/usr/lib:/usr/local/lib64 35 | 36 | RUN apk update \ 37 | && apk add --no-cache openssl libstdc++ supervisor coreutils spdlog perl \ 38 | && rm -rf /var/cache/apk/* 39 | 40 | # Create service users for security isolation 41 | RUN adduser -D -u 3001 -s /bin/sh sls \ 42 | && adduser -D -u 3002 -s /bin/sh srtla 43 | 44 | # Copy binaries from the builder stage 45 | COPY --from=builder /tmp/srtla/srtla_rec /usr/local/bin 46 | 47 | # Copy binaries from the srt-live-server 48 | COPY --from=sls-stage /usr/local/bin/* /usr/local/bin 49 | COPY --from=sls-stage /usr/local/lib/libsrt* /usr/local/lib 50 | 51 | # Copy binary files from the repo 52 | COPY --chmod=755 bin/logprefix /bin/logprefix 53 | 54 | # Copy configuration files from the srt-live-server 55 | COPY --from=sls-stage /etc/sls/sls.conf /etc/sls/sls.conf 56 | 57 | # Copy configuration files from the repo 58 | COPY conf/supervisord.conf /etc/supervisord.conf 59 | 60 | # Expose ports 61 | EXPOSE 5000/udp 4000/udp 4001/udp 8080/tcp 62 | 63 | # Start supervisor 64 | CMD ["/usr/bin/supervisord", "--nodaemon", "--configuration", "/etc/supervisord.conf"] -------------------------------------------------------------------------------- /.github/actions/docker-build/action.yml: -------------------------------------------------------------------------------- 1 | name: 'Docker build' 2 | description: 'Build and Push the image' 3 | inputs: 4 | repository: 5 | required: false 6 | default: 'ghcr.io' 7 | description: 'Repository URL' 8 | username: 9 | required: false 10 | description: 'Repository Username' 11 | password: 12 | required: false 13 | description: 'Repository Password' 14 | image-name: 15 | required: true 16 | description: 'Image name' 17 | image-version: 18 | default: ${{ github.ref_name }} 19 | description: 'Image Version' 20 | push: 21 | default: 'false' 22 | description: 'Should the image be pushed to the repo' 23 | srtla-branch: 24 | default: 'main' 25 | description: 'SRTla branch to build from (main/next)' 26 | sls-tag: 27 | default: 'latest' 28 | description: 'SRT-Live-Server tag to use (latest/next)' 29 | 30 | runs: 31 | using: 'composite' 32 | steps: 33 | - name: Set up Docker Buildx 34 | uses: docker/setup-buildx-action@v2 35 | 36 | - name: Login to GitHub Container Registry 37 | if: ${{ inputs.username && inputs.password }} 38 | uses: docker/login-action@v3 39 | with: 40 | registry: ${{ inputs.repository }} 41 | username: ${{ inputs.username }} 42 | password: ${{ inputs.password }} 43 | 44 | # Determine additional tag based on release type 45 | - name: Set additional tag 46 | id: set-tag 47 | shell: bash 48 | run: | 49 | # Check if this is a pre-release 50 | if [[ "${{ github.event_name }}" == "release" && "${{ github.event.release.prerelease }}" == "true" ]]; then 51 | echo "TAG=next" >> $GITHUB_OUTPUT 52 | echo "Pre-release detected: using next tag" 53 | else 54 | echo "TAG=latest" >> $GITHUB_OUTPUT 55 | echo "Stable release detected: using latest tag" 56 | fi 57 | 58 | - name: Build and Push 59 | uses: docker/build-push-action@v4 60 | with: 61 | context: . 62 | platforms: linux/amd64,linux/arm64 63 | file: Dockerfile 64 | build-args: | 65 | SRTLA_BRANCH=${{ inputs.srtla-branch }} 66 | SLS_TAG=${{ inputs.sls-tag }} 67 | tags: | 68 | ${{ inputs.repository }}/${{ inputs.image-name }}:${{ inputs.image-version }} 69 | ${{ inputs.repository }}/${{ inputs.image-name }}:${{ steps.set-tag.outputs.TAG }} 70 | push: ${{ inputs.push == 'true' }} 71 | cache-from: type=gha,scope=${{ inputs.image-name }}-${{ inputs.image-version }} 72 | cache-to: type=gha,mode=max,scope=${{ inputs.image-name }}-${{ inputs.image-version }} -------------------------------------------------------------------------------- /BUILD_VERSIONS.md: -------------------------------------------------------------------------------- 1 | # Flexible Build System for SRTla Receiver 2 | 3 | This repository implements a flexible build system that allows switching between different versions of `srt-live-server` and `srtla`. 4 | 5 | ## Build Arguments 6 | 7 | The Dockerfile supports the following build arguments: 8 | 9 | - `SRTLA_BRANCH`: SRTla branch (default: `main`, options: `main`, `next`) 10 | - `SLS_TAG`: srt-live-server tag (default: `latest`, options: `latest`, `next`) 11 | 12 | ## Version Selection 13 | 14 | ### Release Workflow 15 | The `release.yml` workflow selects versions based on the release type and optional overrides: 16 | 17 | #### Default Behavior 18 | - **Stable Release** (without "Pre-release" flag): SRTla: `main` branch, SLS: `latest` tag 19 | - **Pre-Release** (with "Pre-release" flag): SRTla: `main` branch, SLS: `latest` tag (but overrides required) 20 | 21 | #### Custom Configuration 22 | You can override the default behavior using keywords in the release description: 23 | 24 | **SRTla Override:** 25 | - `srtla:next` - Uses next branch (only allowed in pre-releases) 26 | 27 | **SLS Override:** 28 | - `sls:next` - Uses next tag (only allowed in pre-releases) 29 | 30 | #### Validation Rules 31 | - **Stable releases** cannot use `next` components 32 | - **Pre-releases** must use at least one `next` component via overrides 33 | - Build will fail if these rules are violated 34 | 35 | #### Release Description Examples 36 | 37 | ``` 38 | # Stable release (main/latest) 39 | Release 1.2.3 40 | 41 | # Pre-release with SRTla override (next/latest) 42 | Release 1.2.3-beta 43 | srtla:next 44 | 45 | # Pre-release with SLS override (main/next) 46 | Release 1.2.3-beta 47 | sls:next 48 | 49 | # Pre-release with both overrides (next/next) 50 | Release 1.2.3-beta 51 | srtla:next 52 | sls:next 53 | 54 | # ❌ Pre-release without overrides → Build fails 55 | Release 1.2.3-beta 56 | ``` 57 | 58 | ## Creating Releases 59 | 60 | 1. **Stable Release**: 61 | - Create a new release on GitHub 62 | - Remove the "Pre-release" flag 63 | - No keywords needed → automatically `main` + `latest` 64 | 65 | 2. **Pre-Release**: 66 | - Create a new release on GitHub 67 | - Enable the "Pre-release" flag 68 | - **Required**: Add at least one keyword to the release description: 69 | - `srtla:next` (for next branch) 70 | - `sls:next` (for next tag) 71 | 72 | ### Automatic Tags 73 | The system automatically creates the following image tags: 74 | - `ghcr.io/openirl/srtla-receiver:{release-tag}` (e.g. `1.2.3`) 75 | - `ghcr.io/openirl/srtla-receiver:latest` (only for stable releases) 76 | - `ghcr.io/openirl/srtla-receiver:next` (only for pre-releases) 77 | 78 | ## Version Combinations 79 | 80 | | Release Type | SRTla Branch | SLS Tag | Usage | Keywords | 81 | |--------------|--------------|----------|------------------------|-------------------------| 82 | | Stable | `main` | `latest` | Production Release | None | 83 | | Pre-Release | `next` | `latest` | Testing SRTla features | `srtla:next` | 84 | | Pre-Release | `main` | `next` | Testing SLS features | `sls:next` | 85 | | Pre-Release | `next` | `next` | Testing both features | `srtla:next` `sls:next` | 86 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | name: 'Release' 2 | 3 | on: 4 | release: 5 | types: [ published ] 6 | 7 | env: 8 | docker_repo: 'ghcr.io' 9 | image_name: 'openirl/srtla-receiver' 10 | 11 | jobs: 12 | release: 13 | runs-on: ubuntu-latest 14 | permissions: 15 | packages: write 16 | contents: read 17 | steps: 18 | - uses: actions/checkout@v3 19 | 20 | # Determine version strategy based on release type and validate overrides 21 | - name: Determine version strategy 22 | id: version-strategy 23 | shell: bash 24 | run: | 25 | # Default values for both release types 26 | SRTLA_BRANCH="main" 27 | SLS_TAG="latest" 28 | 29 | # Check if this is a pre-release 30 | if [[ "${{ github.event.release.prerelease }}" == "true" ]]; then 31 | RELEASE_TYPE="pre-release" 32 | echo "Pre-release detected: using main/latest by default, overrides required" 33 | else 34 | RELEASE_TYPE="stable" 35 | echo "Stable release detected: using main/latest" 36 | fi 37 | 38 | # Check release description for component overrides 39 | RELEASE_DESCRIPTION="${{ github.event.release.body }}" 40 | 41 | # Check for SRTla version override 42 | if echo "$RELEASE_DESCRIPTION" | grep -qi "srtla:next"; then 43 | if [[ "$RELEASE_TYPE" == "stable" ]]; then 44 | echo "ERROR: srtla:next is not allowed in stable releases" 45 | exit 1 46 | fi 47 | SRTLA_BRANCH="next" 48 | echo "SRTla override: using next branch" 49 | fi 50 | 51 | # Check for SLS version override 52 | if echo "$RELEASE_DESCRIPTION" | grep -qi "sls:next"; then 53 | if [[ "$RELEASE_TYPE" == "stable" ]]; then 54 | echo "ERROR: sls:next is not allowed in stable releases" 55 | exit 1 56 | fi 57 | SLS_TAG="next" 58 | echo "SLS override: using next tag" 59 | fi 60 | 61 | # Validate that pre-releases have at least one next component 62 | if [[ "$RELEASE_TYPE" == "pre-release" && "$SRTLA_BRANCH" == "main" && "$SLS_TAG" == "latest" ]]; then 63 | echo "ERROR: Pre-releases must use at least one next component (srtla:next or sls:next)" 64 | exit 1 65 | fi 66 | 67 | # Set outputs 68 | echo "SRTLA_BRANCH=$SRTLA_BRANCH" >> $GITHUB_OUTPUT 69 | echo "SLS_TAG=$SLS_TAG" >> $GITHUB_OUTPUT 70 | 71 | echo "Version configuration:" 72 | echo " Release type: $RELEASE_TYPE" 73 | echo " SRTla branch: $SRTLA_BRANCH" 74 | echo " SLS tag: $SLS_TAG" 75 | 76 | - name: Docker Build 77 | uses: ./.github/actions/docker-build 78 | with: 79 | repository: ${{ env.docker_repo }} 80 | username: ${{ github.actor }} 81 | password: ${{ secrets.GITHUB_TOKEN }} 82 | image-name: ${{ env.image_name }} 83 | srtla-branch: ${{ steps.version-strategy.outputs.SRTLA_BRANCH }} 84 | sls-tag: ${{ steps.version-strategy.outputs.SLS_TAG }} 85 | push: true -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # SRTla Receiver 2 | 3 | SRTla receiver with support for multiple streams and statistics integration. 4 | 5 | ## Project Information 6 | 7 | This project is based on the following components: 8 | 9 | - SRT: [onsmith/srt](https://github.com/onsmith/srt) 10 | - SRTla: [OpenIRL/srtla](https://github.com/OpenIRL/srtla) 11 | - SRT-Live-Server: [OpenIRL/srt-live-server](https://github.com/OpenIRL/srt-live-server) 12 | 13 | ### Project Support 14 | 15 | If you'd like to support this project, please visit my GoFundMe page: [gofundme](https://gofund.me/07644414) 16 | 17 | Your support helps enable further development and improvements. 18 | 19 | ## Getting Started 20 | 21 | ### Install the Receiver 22 | 23 | The Receiver provides a shell script for easy installation on Ubuntu and Debian. Complete the following steps to install 24 | using the shell script: 25 | 26 | 1. Download the runtime management script (`receiver.sh`) to your machine: 27 | ```shell 28 | curl -Lso receiver.sh "https://raw.githubusercontent.com/OpenIRL/srtla-receiver/refs/heads/main/receiver.sh" && chmod 700 receiver.sh 29 | ``` 30 | 2. Run the installer script. It will create `./data` directory and `./.apikey` file they will be created realtive to the 31 | location of the `receiver.sh` 32 | ```shell 33 | ./receiver.sh install 34 | ``` 35 | 3. Complete the prompts in the installer (most time just pressing enter) 36 | 37 | ### Create First Publisher 38 | 39 | To use the started container, open the management URL (e.g., `http://127.0.0.1:3000`) shown in the console in your browser. 40 | 41 | #### Configuration Steps 42 | 43 | 1. Click on "Configure Settings" on the welcome screen 44 | 2. In the modal that opens, you'll find 2 input fields and one switch. Enter the API key shown in the console 45 | - If you don't have the API key anymore, navigate to the directory where srtla-receiver is installed and run `cat .apikey` 46 | 3. Click "Save" after entering the API key 47 | 4. On the next screen, a new "Add Stream" button will appear. Click it and optionally fill in a description 48 | 5. After adding the publisher, click the arrow icon. In the Player section, you'll find a link icon 49 | 6. Click the link icon to get the stream URLs including the stats URLs as shown in the examples below 50 | 51 | #### Sending a Stream 52 | 53 | ##### SRTla 54 | 55 | | Type | URL | 56 | |---------|-------------------------------------------------------------------------| 57 | | Schema | `srtla://:5000?streamid=` | 58 | | Example | `srtla://127.0.0.1:5000?streamid=live_7388b95f0a6c4f69954f4519f204a554` | 59 | 60 | ##### SRT 61 | 62 | | Type | URL | 63 | |---------|-----------------------------------------------------------------------| 64 | | Schema | `srt://:4001?streamid=` | 65 | | Example | `srt://127.0.0.1:4001?streamid=live_7388b95f0a6c4f69954f4519f204a554` | 66 | 67 | #### Receiving a Stream 68 | 69 | ##### SRT 70 | 71 | | Type | URL | 72 | |---------|-----------------------------------------------------------------------| 73 | | Schema | `srt://:4000?streamid=` | 74 | | Example | `srt://127.0.0.1:4000?streamid=play_60a0055a7fdb436d92fab3a943f5c55c` | 75 | 76 | ## Statistics Integration 77 | 78 | The SRTla Receiver provides a statistics interface that can be used for integration with tools like NOALBS (Node OBS Automatic Live Switching). 79 | 80 | ### Statistics Endpoint 81 | 82 | | Type | URL | 83 | |---------|---------------------------------------------------------------------| 84 | | Schema | `http://:8080/stats/` | 85 | | Example | `http://127.0.0.1:8080/stats/play_60a0055a7fdb436d92fab3a943f5c55c` | 86 | 87 | ### Statistics Endpoint Legacy (NOALBS version < 2.14.0) 88 | 89 | | Type | URL | 90 | |------------------|------------------------------------------------------------------------------| 91 | | Schema (Legacy) | `http://:8080/stats/?legacy=1` | 92 | | Example (Legacy) | `http://127.0.0.1:8080/stats/play_60a0055a7fdb436d92fab3a943f5c55c?legacy=1` | 93 | 94 | ### NOALBS Integration 95 | 96 | To use the SRTla Receiver with NOALBS, you can specify the statistics endpoint in your NOALBS configuration. This allows 97 | for automatic scene switching based on stream metrics. 98 | Example NOALBS configuration: 99 | 100 | ```json 101 | { 102 | # rest of the config ... 103 | "switcher": { 104 | # rest of the config ... 105 | "streamServers": [ 106 | { 107 | "streamServer": { 108 | "type": "OpenIRL", 109 | "statsUrl": "http://127.0.0.1:8080/stats/play_60a0055a7fdb436d92fab3a943f5c55c" 110 | }, 111 | "name": "Stream", 112 | "priority": 0, 113 | "enabled": true 114 | } 115 | ] 116 | # rest of the config ... 117 | } 118 | # rest of the config ... 119 | } 120 | ``` 121 |
122 | NOLABS Version < 2.14.0 123 | 124 | ```json 125 | { 126 | # rest of the config ... 127 | "switcher": { 128 | # rest of the config ... 129 | "streamServers": [ 130 | { 131 | "streamServer": { 132 | "type": "SrtLiveServer", 133 | "statsUrl": "http://127.0.0.1:8080/stats/play_60a0055a7fdb436d92fab3a943f5c55c?legacy=1", 134 | "publisher": "live" 135 | }, 136 | "name": "Stream", 137 | "priority": 0, 138 | "enabled": true 139 | } 140 | ] 141 | # rest of the config ... 142 | } 143 | # rest of the config ... 144 | } 145 | ``` 146 | 147 |
148 | 149 | ## Troubleshooting 150 | 151 | If you encounter issues with the SRTla Receiver, ensure that: 152 | 153 | - All required ports (5000/udp, 4000/udp, 4001/udp, 8080/tcp) are accessible 154 | - Stream IDs are correctly formatted 155 | - Your firewall settings allow UDP traffic on the configured ports 156 | 157 | ## Contributing 158 | 159 | Contributions to the project are welcome! Please open an issue or pull request on GitHub. 160 | -------------------------------------------------------------------------------- /receiver.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Branch configuration - can be overridden by command line flag 4 | DEFAULT_BRANCH="main" 5 | SELECTED_BRANCH="$DEFAULT_BRANCH" 6 | 7 | # (Function removed - replaced with inline parsing) 8 | 9 | # Function to get the selected branch 10 | get_branch() { 11 | echo "$SELECTED_BRANCH" 12 | } 13 | 14 | # Function to get branch display name 15 | get_branch_display_name() { 16 | case "$SELECTED_BRANCH" in 17 | "main") 18 | echo "Stable (main)" 19 | ;; 20 | "next") 21 | echo "Beta (next)" 22 | ;; 23 | *) 24 | echo "Custom ($SELECTED_BRANCH)" 25 | ;; 26 | esac 27 | } 28 | 29 | # Color detection and setup 30 | setup_colors() { 31 | # Check if stdout is a terminal and supports colors 32 | if [[ -t 1 ]] && command -v tput &> /dev/null && tput colors &> /dev/null && [ $(tput colors) -ge 8 ]; then 33 | # Bright and more readable colors 34 | ERROR='\033[1;31m' # Bright Red - for errors 35 | SUCCESS='\033[1;32m' # Bright Green - for success messages 36 | WARNING='\033[1;33m' # Bright Yellow - for warnings 37 | INFO='\033[1;36m' # Bright Cyan - for information 38 | HEADER='\033[1;34m' # Bright Blue - for headers/titles 39 | HIGHLIGHT='\033[1;35m' # Bright Magenta - for highlighting important text 40 | MUTED='\033[0;37m' # Light Gray - for less important text 41 | BOLD='\033[1m' # Bold text 42 | NC='\033[0m' # No Color/Reset 43 | else 44 | # No color support or non-terminal output 45 | ERROR='' 46 | SUCCESS='' 47 | WARNING='' 48 | INFO='' 49 | HEADER='' 50 | HIGHLIGHT='' 51 | MUTED='' 52 | BOLD='' 53 | NC='' 54 | fi 55 | } 56 | 57 | # Initialize colors 58 | setup_colors 59 | 60 | # Script path 61 | SCRIPT_PATH="$0" 62 | SCRIPT_NAME=$(basename "$0") 63 | 64 | # Function to check OS compatibility 65 | check_os_compatibility() { 66 | # Check if lsb_release command exists 67 | if ! command -v lsb_release &> /dev/null; then 68 | if [ -f /etc/os-release ]; then 69 | . /etc/os-release 70 | OS_ID="$ID" 71 | else 72 | echo -e "${ERROR}Cannot determine operating system. This script supports only Debian and Ubuntu.${NC}" 73 | exit 1 74 | fi 75 | else 76 | OS_ID=$(lsb_release -is | tr '[:upper:]' '[:lower:]') 77 | fi 78 | 79 | # Check if OS is supported 80 | if [[ "$OS_ID" != "debian" && "$OS_ID" != "ubuntu" ]]; then 81 | echo -e "${ERROR}Unsupported operating system: ${HIGHLIGHT}$OS_ID${NC}" 82 | echo -e "${WARNING}This script is designed for Debian and Ubuntu systems only.${NC}" 83 | exit 1 84 | fi 85 | 86 | echo -e "${SUCCESS}Detected operating system: ${HIGHLIGHT}$OS_ID${NC}" 87 | return 0 88 | } 89 | 90 | show_ascii_logo() { 91 | echo -e "${HEADER}" 92 | echo " ___ ___ ____ _" 93 | echo " / _ \ _ __ ___ _ __ |_ _| _ \| |" 94 | echo "| | | | '_ \ / _ \ '_ \ | || |_) | |" 95 | echo "| |_| | |_) | __/ | | || || _ <| |___" 96 | echo " \___/| .__/ \___|_| |_|___|_| \_\_____|" 97 | echo " |_|" 98 | echo -e "${NC}" 99 | } 100 | 101 | # Function to display help 102 | show_help() { 103 | show_ascii_logo 104 | 105 | echo -e "${HEADER}${BOLD}SRTla-Receiver Script${NC}" 106 | echo 107 | echo "Usage: $0 [BRANCH_OPTIONS] [COMMAND]" 108 | echo 109 | echo "Commands:" 110 | echo " install Install/update Docker and configure SRTla-Receiver" 111 | echo " (only installs missing components, preserves existing config)" 112 | echo " start Start SRTla-Receiver" 113 | echo " stop Stop SRTla-Receiver" 114 | echo " update Update SRTla-Receiver container" 115 | echo " updateself Update this script" 116 | echo " remove Remove SRTla-Receiver container" 117 | echo " status Show status of SRTla-Receiver" 118 | echo " reset Reset system (deletes all data!)" 119 | echo " help Show this help" 120 | echo 121 | echo "Branch Options:" 122 | echo " --use-main Use stable version (default)" 123 | echo " --use-next Use beta version" 124 | echo " --branch=BRANCH Use specific branch" 125 | echo 126 | echo "Examples:" 127 | echo " $0 install # Install using stable version" 128 | echo " $0 --use-next install # Install using beta version" 129 | echo " $0 --branch=custom-branch update" 130 | echo 131 | } 132 | 133 | # Function to check if Docker is installed 134 | check_docker() { 135 | if ! command -v docker &> /dev/null; then 136 | echo -e "${ERROR}Docker is not installed.${NC}" 137 | echo -e "Please run '${HIGHLIGHT}$0 install${NC}' first." 138 | exit 1 139 | fi 140 | 141 | if ! command -v docker-compose &> /dev/null && ! docker compose version &> /dev/null; then 142 | echo -e "${ERROR}Docker Compose is not installed.${NC}" 143 | echo -e "Please run '${HIGHLIGHT}$0 install${NC}' first." 144 | exit 1 145 | fi 146 | 147 | echo -e "${SUCCESS}Docker and Docker Compose are installed.${NC}" 148 | } 149 | 150 | 151 | # Function to check if user is in docker group 152 | check_docker_group() { 153 | if groups | grep -q docker; then 154 | return 0 # User is in docker group 155 | else 156 | return 1 # User is not in docker group 157 | fi 158 | } 159 | 160 | # Function to check Docker installation status 161 | check_docker_status() { 162 | local docker_installed=false 163 | local compose_installed=false 164 | local user_in_group=false 165 | 166 | # Check Docker 167 | if command -v docker &> /dev/null; then 168 | docker_installed=true 169 | fi 170 | 171 | # Check Docker Compose 172 | if command -v docker-compose &> /dev/null || docker compose version &> /dev/null 2>&1; then 173 | compose_installed=true 174 | fi 175 | 176 | # Check if user is in docker group 177 | if check_docker_group; then 178 | user_in_group=true 179 | fi 180 | 181 | echo "$docker_installed,$compose_installed,$user_in_group" 182 | } 183 | 184 | # Function to install Docker (only missing components) 185 | install_docker() { 186 | # Check OS compatibility first 187 | check_os_compatibility 188 | 189 | # Get current Docker status 190 | IFS=',' read -r docker_installed compose_installed user_in_group <<< "$(check_docker_status)" 191 | 192 | local needs_restart=false 193 | 194 | echo -e "${INFO}Checking Docker installation status...${NC}" 195 | 196 | if [ "$docker_installed" = "true" ]; then 197 | echo -e "${SUCCESS}✓ Docker is already installed${NC}" 198 | else 199 | echo -e "${INFO}→ Installing Docker on ${HIGHLIGHT}$OS_ID${NC}..." 200 | 201 | # Install dependencies 202 | sudo apt-get update 203 | sudo apt-get install -y apt-transport-https ca-certificates curl software-properties-common gnupg 204 | 205 | # Add Docker's official GPG key 206 | curl -fsSL https://download.docker.com/linux/$OS_ID/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg 207 | 208 | # Add Docker repository - using the detected OS 209 | echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/$OS_ID $(lsb_release -cs) stable" | \ 210 | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null 211 | 212 | # Install Docker 213 | sudo apt-get update 214 | sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin 215 | 216 | echo -e "${SUCCESS}✓ Docker has been installed${NC}" 217 | needs_restart=true 218 | fi 219 | 220 | if [ "$compose_installed" = "true" ]; then 221 | echo -e "${SUCCESS}✓ Docker Compose is already installed${NC}" 222 | else 223 | echo -e "${INFO}→ Installing Docker Compose...${NC}" 224 | sudo apt-get update 225 | sudo apt-get install -y docker-compose-plugin 226 | echo -e "${SUCCESS}✓ Docker Compose has been installed${NC}" 227 | needs_restart=true 228 | fi 229 | 230 | if [ "$user_in_group" = "true" ]; then 231 | echo -e "${SUCCESS}✓ User is already in docker group${NC}" 232 | else 233 | echo -e "${INFO}→ Adding user to docker group...${NC}" 234 | sudo usermod -aG docker $USER 235 | echo -e "${SUCCESS}✓ User added to docker group${NC}" 236 | needs_restart=true 237 | fi 238 | 239 | if [ "$needs_restart" = "true" ]; then 240 | echo -e "${WARNING}Please restart your shell or run ${HIGHLIGHT}'newgrp docker'${NC}${WARNING} to activate the Docker group.${NC}" 241 | else 242 | echo -e "${SUCCESS}All Docker components are already properly installed and configured.${NC}" 243 | fi 244 | } 245 | 246 | # Function to get public IPv4 address 247 | get_public_ip() { 248 | local ip="" 249 | 250 | # Try different methods to get the public IP 251 | if command -v curl &> /dev/null; then 252 | ip=$(curl -4 -s --max-time 5 ifconfig.me 2>/dev/null || curl -s --max-time 5 icanhazip.com 2>/dev/null || curl -s --max-time 5 ipecho.net/plain 2>/dev/null) 253 | fi 254 | 255 | # Fallback to local IP if public IP cannot be determined 256 | if [ -z "$ip" ]; then 257 | ip=$(hostname -I | awk '{print $1}') 258 | fi 259 | 260 | echo "$ip" 261 | } 262 | 263 | # Function to extract API key from Docker logs 264 | extract_api_key() { 265 | echo -e "${INFO}Extracting API key from container logs...${NC}" 266 | 267 | # Check if containers already exist (indicating they were started before) 268 | local container_exists=false 269 | if docker compose version &> /dev/null; then 270 | if docker compose ps -a | grep -q "receiver"; then 271 | container_exists=true 272 | fi 273 | else 274 | if docker-compose ps -a | grep -q "receiver"; then 275 | container_exists=true 276 | fi 277 | fi 278 | 279 | # First, try to extract from existing logs 280 | local api_key="" 281 | if docker compose version &> /dev/null; then 282 | api_key=$(docker compose logs receiver 2>/dev/null | grep "Generated default admin API key:" | sed 's/.*Generated default admin API key: \([A-Za-z0-9]*\).*/\1/' | tail -1) 283 | else 284 | api_key=$(docker-compose logs receiver 2>/dev/null | grep "Generated default admin API key:" | sed 's/.*Generated default admin API key: \([A-Za-z0-9]*\).*/\1/' | tail -1) 285 | fi 286 | 287 | if [ -n "$api_key" ]; then 288 | echo "$api_key" > .apikey 289 | echo -e "${SUCCESS}API key successfully extracted and saved to .apikey${NC}" 290 | echo -e "${INFO}Your API key: $api_key${NC}" 291 | return 0 292 | fi 293 | 294 | # If container already exists but no API key found, it means the system was already initialized 295 | if [ "$container_exists" = true ]; then 296 | echo -e "${WARNING}Container was already started before. API key is only generated on the very first start.${NC}" 297 | echo -e "${WARNING}Possible solutions:${NC}" 298 | if docker compose version &> /dev/null; then 299 | echo -e "${INFO}1. Check all container logs: docker compose logs receiver | grep 'Generated default admin API key'${NC}" 300 | else 301 | echo -e "${INFO}1. Check all container logs: docker-compose logs receiver | grep 'Generated default admin API key'${NC}" 302 | fi 303 | echo -e "${INFO}2. If you need a new API key, use:${NC}" 304 | echo -e "${INFO} ./receiver.sh reset${NC}" 305 | echo -e "${ERROR}WARNING: Resetting will delete all stored data!${NC}" 306 | return 1 307 | fi 308 | 309 | # If this is a fresh start, wait for API key generation 310 | local max_attempts=30 311 | local attempt=0 312 | 313 | echo -e "${INFO}Waiting for API key generation on first start...${NC}" 314 | 315 | # First, ensure the container is actually running 316 | echo -e "${INFO}Checking if container is running...${NC}" 317 | local container_running=false 318 | local startup_attempts=0 319 | 320 | while [ $startup_attempts -lt 10 ] && [ "$container_running" = false ]; do 321 | if docker compose version &> /dev/null; then 322 | if docker compose ps | grep -q "running"; then 323 | container_running=true 324 | fi 325 | else 326 | if docker-compose ps | grep -q "running"; then 327 | container_running=true 328 | fi 329 | fi 330 | 331 | if [ "$container_running" = false ]; then 332 | echo -e "${WARNING}Container still starting up... (${startup_attempts}/10)${NC}" 333 | sleep 2 334 | startup_attempts=$((startup_attempts + 1)) 335 | fi 336 | done 337 | 338 | if [ "$container_running" = false ]; then 339 | echo -e "${ERROR}Container is not running. Cannot extract API key.${NC}" 340 | return 1 341 | fi 342 | 343 | echo -e "${SUCCESS}Container is running. Looking for API key...${NC}" 344 | 345 | while [ $attempt -lt $max_attempts ] && [ -z "$api_key" ]; do 346 | sleep 2 347 | 348 | # Extract API key from logs 349 | if docker compose version &> /dev/null; then 350 | api_key=$(docker compose logs receiver 2>/dev/null | grep "Generated default admin API key:" | sed 's/.*Generated default admin API key: \([A-Za-z0-9]*\).*/\1/' | tail -1) 351 | else 352 | api_key=$(docker-compose logs receiver 2>/dev/null | grep "Generated default admin API key:" | sed 's/.*Generated default admin API key: \([A-Za-z0-9]*\).*/\1/' | tail -1) 353 | fi 354 | 355 | attempt=$((attempt + 1)) 356 | 357 | if [ -n "$api_key" ]; then 358 | echo "$api_key" > .apikey 359 | echo -e "${SUCCESS}API key successfully extracted and saved to .apikey${NC}" 360 | echo -e "${INFO}Your API key: $api_key${NC}" 361 | return 0 362 | fi 363 | 364 | echo -e "${WARNING}Waiting for API key generation... (attempt $attempt/$max_attempts)${NC}" 365 | done 366 | 367 | echo -e "${WARNING}API key could not be automatically extracted.${NC}" 368 | echo -e "${WARNING}Please check the container logs manually:${NC}" 369 | if docker compose version &> /dev/null; then 370 | echo -e "${INFO}docker compose logs receiver | grep 'Generated default admin API key'${NC}" 371 | else 372 | echo -e "${INFO}docker-compose logs receiver | grep 'Generated default admin API key'${NC}" 373 | fi 374 | return 1 375 | } 376 | 377 | # Function to reset system for new API key 378 | reset_system() { 379 | echo -e "${WARNING}WARNING: This action will delete all stored data and generate a new API key!${NC}" 380 | echo -e "${ERROR}All streams, users and settings will be lost!${NC}" 381 | echo 382 | read -p "Are you sure you want to reset the system? (yes/no): " confirm 383 | 384 | if [ "$confirm" != "yes" ]; then 385 | echo -e "${INFO}Reset cancelled.${NC}" 386 | return 1 387 | fi 388 | 389 | echo -e "${INFO}Resetting system...${NC}" 390 | 391 | # Stop and remove containers 392 | if [ -f "docker-compose.yml" ]; then 393 | if docker compose version &> /dev/null; then 394 | docker compose down --volumes --remove-orphans 395 | else 396 | docker-compose down --volumes --remove-orphans 397 | fi 398 | fi 399 | 400 | # Remove data directory 401 | if [ -d "data" ]; then 402 | sudo rm -rf data 403 | echo -e "${SUCCESS}data directory removed.${NC}" 404 | fi 405 | 406 | # Remove API key file 407 | if [ -f ".apikey" ]; then 408 | rm -f .apikey 409 | echo -e "${SUCCESS}.apikey file removed.${NC}" 410 | fi 411 | 412 | # Recreate data directory 413 | create_data_directory 414 | 415 | echo -e "${SUCCESS}System successfully reset.${NC}" 416 | echo -e "${INFO}You can now run './receiver.sh start' to generate a new API key.${NC}" 417 | } 418 | 419 | # Function to download Docker Compose file 420 | download_compose_file() { 421 | local compose_url="https://raw.githubusercontent.com/OpenIRL/srtla-receiver/refs/heads/$(get_branch)/docker-compose.prod.yml" 422 | 423 | echo -e "${INFO}Downloading Docker Compose file ($(get_branch_display_name))...${NC}" 424 | 425 | if curl -s -o "docker-compose.yml" "$compose_url"; then 426 | echo -e "${SUCCESS}Docker Compose file successfully downloaded.${NC}" 427 | return 0 428 | else 429 | echo -e "${ERROR}Error downloading Docker Compose file.${NC}" 430 | return 1 431 | fi 432 | } 433 | 434 | # Function to create .env file 435 | create_env_file() { 436 | local app_url="$1" 437 | local sls_mgnt_port="$2" 438 | local srt_player_port="$3" 439 | local srt_sender_port="$4" 440 | local sls_stats_port="$5" 441 | local srtla_port="$6" 442 | 443 | cat > .env << EOF 444 | # Base URL for the application 445 | APP_URL=$app_url 446 | 447 | # Management UI Port 448 | SLS_MGNT_PORT=$sls_mgnt_port 449 | 450 | # SRT Player Port 451 | SRT_PLAYER_PORT=$srt_player_port 452 | 453 | # SRT Sender Port 454 | SRT_SENDER_PORT=$srt_sender_port 455 | 456 | # SLS Statistics Port 457 | SLS_STATS_PORT=$sls_stats_port 458 | 459 | # SRTla Port 460 | SRTLA_PORT=$srtla_port 461 | EOF 462 | 463 | echo -e "${SUCCESS}.env file created.${NC}" 464 | } 465 | 466 | # Function to create data directory 467 | create_data_directory() { 468 | local sls_uid=3001 469 | 470 | if [ ! -d "data" ]; then 471 | if mkdir -p data 2>/dev/null; then 472 | echo -e "${INFO}→ data directory created${NC}" 473 | else 474 | echo -e "${ERROR}ERROR: Could not create data directory${NC}" 475 | return 1 476 | fi 477 | 478 | if sudo chown "$sls_uid" data 2>/dev/null; then 479 | echo -e "${SUCCESS}✓ data directory ownership set to UID $sls_uid${NC}" 480 | else 481 | echo -e "${ERROR}ERROR: Could not change ownership to UID $sls_uid${NC}" 482 | return 1 483 | fi 484 | 485 | # Set permissions 486 | if chmod 755 data 2>/dev/null; then 487 | echo -e "${SUCCESS}✓ data directory permissions set to 755${NC}" 488 | fi 489 | 490 | echo -e "${SUCCESS}✓ data directory is ready${NC}" 491 | return 0 492 | else 493 | echo -e "${SUCCESS}✓ data directory already exists${NC}" 494 | 495 | # Check current ownership 496 | local current_owner=$(stat -c "%u" data 2>/dev/null || echo "unknown") 497 | if [ "$current_owner" != "unknown" ]; then 498 | echo -e "${INFO}Current owner (UID): $current_owner${NC}" 499 | 500 | # Fix ownership if needed 501 | if [ "$current_owner" != "$sls_uid" ]; then 502 | echo -e "${WARNING}→ Fixing data directory ownership...${NC}" 503 | if sudo chown "$sls_uid" data 2>/dev/null; then 504 | echo -e "${SUCCESS}✓ data directory ownership corrected to UID $sls_uid${NC}" 505 | else 506 | echo -e "${ERROR}ERROR: Could not change ownership. Current UID: $current_owner${NC}" 507 | return 1 508 | fi 509 | else 510 | echo -e "${SUCCESS}✓ data directory ownership is correct (UID $sls_uid)${NC}" 511 | fi 512 | fi 513 | fi 514 | } 515 | 516 | # Function to start SRTla-Receiver 517 | start_receiver() { 518 | check_docker 519 | 520 | if [ ! -f "docker-compose.yml" ]; then 521 | echo -e "${ERROR}docker-compose.yml file not found.${NC}" 522 | echo -e "Please run '${WARNING}$0 install${NC}' first." 523 | exit 1 524 | fi 525 | 526 | if [ ! -f ".env" ]; then 527 | echo -e "${ERROR}.env file not found.${NC}" 528 | echo -e "Please run '${WARNING}$0 install${NC}' first." 529 | exit 1 530 | fi 531 | 532 | echo -e "${INFO}Starting SRTla-Receiver...${NC}" 533 | 534 | # Use Docker Compose (new or old syntax) 535 | if docker compose version &> /dev/null; then 536 | docker compose up -d 537 | else 538 | docker-compose up -d 539 | fi 540 | 541 | if [ $? -eq 0 ]; then 542 | echo -e "${SUCCESS}SRTla-Receiver successfully started.${NC}" 543 | 544 | # Extract API key if not present 545 | if [ ! -f ".apikey" ]; then 546 | echo -e "${INFO}Waiting for containers to fully initialize...${NC}" 547 | sleep 5 548 | echo -e "${INFO}Trying to extract API key...${NC}" 549 | extract_api_key 550 | else 551 | echo -e "${SUCCESS}API key already present in .apikey${NC}" 552 | fi 553 | 554 | # Show status 555 | echo -e "${HEADER}Available services:${NC}" 556 | if [ -f ".env" ]; then 557 | source .env 558 | echo -e "${SUCCESS}Management UI: http://$(get_public_ip):${SLS_MGNT_PORT:-3000}${NC}" 559 | echo -e "${SUCCESS}Backend API: ${APP_URL}${NC}" 560 | echo -e "${SUCCESS}SRTla Port: ${SRTLA_PORT:-5000}/udp${NC}" 561 | echo -e "${SUCCESS}SRT Sender Port: ${SRT_SENDER_PORT:-4001}/udp${NC}" 562 | echo -e "${SUCCESS}SRT Player Port: ${SRT_PLAYER_PORT:-4000}/udp${NC}" 563 | echo -e "${SUCCESS}Statistics Port: ${SLS_STATS_PORT:-8080}/tcp${NC}" 564 | fi 565 | else 566 | echo -e "${ERROR}Error starting SRTla-Receiver.${NC}" 567 | exit 1 568 | fi 569 | } 570 | 571 | # Function to stop SRTla-Receiver 572 | stop_receiver() { 573 | check_docker 574 | 575 | if [ ! -f "docker-compose.yml" ]; then 576 | echo -e "${WARNING}docker-compose.yml file not found. No containers to stop.${NC}" 577 | return 578 | fi 579 | 580 | echo -e "${INFO}Stopping SRTla-Receiver...${NC}" 581 | 582 | # Use Docker Compose (new or old syntax) 583 | if docker compose version &> /dev/null; then 584 | docker compose down 585 | else 586 | docker-compose down 587 | fi 588 | 589 | echo -e "${SUCCESS}SRTla-Receiver stopped.${NC}" 590 | } 591 | 592 | # Function to update SRTla-Receiver 593 | update_receiver() { 594 | check_docker 595 | 596 | if [ ! -f "docker-compose.yml" ]; then 597 | echo -e "${ERROR}docker-compose.yml file not found.${NC}" 598 | echo -e "Please run '${WARNING}$0 install${NC}' first." 599 | exit 1 600 | fi 601 | 602 | echo -e "${INFO}Updating SRTla-Receiver ($(get_branch_display_name))...${NC}" 603 | 604 | # Download new Docker Compose file 605 | download_compose_file 606 | 607 | # Update images 608 | if docker compose version &> /dev/null; then 609 | docker compose pull 610 | docker compose down 611 | docker compose up -d 612 | else 613 | docker-compose pull 614 | docker-compose down 615 | docker-compose up -d 616 | fi 617 | 618 | echo -e "${SUCCESS}SRTla-Receiver successfully updated.${NC}" 619 | } 620 | 621 | # Function to update script 622 | update_self() { 623 | echo -e "${INFO}Updating script...${NC}" 624 | 625 | # Create temporary backup 626 | local backup_file="${SCRIPT_PATH}.backup" 627 | cp "$SCRIPT_PATH" "$backup_file" 628 | echo -e "${WARNING}Backup of current script created: $backup_file${NC}" 629 | 630 | # Download latest version from GitHub 631 | local repo_url="https://raw.githubusercontent.com/OpenIRL/srtla-receiver/refs/heads/$(get_branch)/receiver.sh" 632 | echo -e "${INFO}Downloading script from $(get_branch_display_name) branch...${NC}" 633 | 634 | if curl -s -o "${SCRIPT_PATH}.new" "$repo_url"; then 635 | chmod +x "${SCRIPT_PATH}.new" 636 | mv "${SCRIPT_PATH}.new" "$SCRIPT_PATH" 637 | echo -e "${SUCCESS}Script successfully updated.${NC}" 638 | echo -e "${WARNING}Please restart the script to apply the changes.${NC}" 639 | else 640 | echo -e "${ERROR}Error downloading the script.${NC}" 641 | echo -e "${WARNING}Restoring backup...${NC}" 642 | mv "$backup_file" "$SCRIPT_PATH" 643 | echo -e "${SUCCESS}Backup restored.${NC}" 644 | exit 1 645 | fi 646 | } 647 | 648 | # Function to remove SRTla-Receiver 649 | remove_container() { 650 | check_docker 651 | echo -e "${INFO}Removing SRTla-Receiver containers...${NC}" 652 | 653 | if [ -f "docker-compose.yml" ]; then 654 | # Use Docker Compose (new or old syntax) 655 | if docker compose version &> /dev/null; then 656 | docker compose down --volumes --remove-orphans 657 | else 658 | docker-compose down --volumes --remove-orphans 659 | fi 660 | echo -e "${SUCCESS}SRTla-Receiver containers removed.${NC}" 661 | else 662 | echo -e "${WARNING}docker-compose.yml file not found. No containers to remove.${NC}" 663 | fi 664 | } 665 | 666 | # Function to show status 667 | show_status() { 668 | check_docker 669 | echo -e "${HEADER}SRTla-Receiver status:${NC}" 670 | 671 | if [ -f "docker-compose.yml" ]; then 672 | echo -e "${SUCCESS}Docker Compose file found.${NC}" 673 | 674 | # Use Docker Compose (new or old syntax) 675 | if docker compose version &> /dev/null; then 676 | docker compose ps 677 | else 678 | docker-compose ps 679 | fi 680 | else 681 | echo -e "${WARNING}docker-compose.yml file not found.${NC}" 682 | fi 683 | 684 | if [ -f ".env" ]; then 685 | echo -e "${HEADER}Environment settings:${NC}" 686 | source .env 687 | echo -e "Base URL: ${APP_URL}" 688 | echo -e "Management UI Port: ${SLS_MGNT_PORT}" 689 | echo -e "SRTla Port: ${SRTLA_PORT}" 690 | echo -e "SRT Sender Port: ${SRT_SENDER_PORT}" 691 | echo -e "SRT Player Port: ${SRT_PLAYER_PORT}" 692 | echo -e "Statistics Port: ${SLS_STATS_PORT}" 693 | fi 694 | 695 | if [ -f ".apikey" ]; then 696 | echo -e "${HEADER}API Key:${NC}" 697 | cat .apikey 698 | else 699 | echo -e "${WARNING}No API key found. Will be automatically extracted on next start.${NC}" 700 | fi 701 | } 702 | 703 | # Interactive installation 704 | interactive_install() { 705 | # Show logo 706 | show_ascii_logo 707 | 708 | # Check OS compatibility first 709 | check_os_compatibility 710 | 711 | # Install Docker (only missing components) 712 | install_docker 713 | 714 | # Show selected version 715 | echo -e "${SUCCESS}Using $(get_branch_display_name) version.${NC}" 716 | 717 | # Check existing installation 718 | echo -e "${INFO}Checking existing installation...${NC}" 719 | 720 | local compose_exists=false 721 | local env_exists=false 722 | local data_exists=false 723 | local apikey_exists=false 724 | 725 | if [ -f "docker-compose.yml" ]; then 726 | compose_exists=true 727 | echo -e "${SUCCESS}✓ docker-compose.yml already exists${NC}" 728 | fi 729 | 730 | if [ -f ".env" ]; then 731 | env_exists=true 732 | echo -e "${SUCCESS}✓ .env file already exists${NC}" 733 | fi 734 | 735 | if [ -d "data" ]; then 736 | data_exists=true 737 | echo -e "${SUCCESS}✓ data directory already exists${NC}" 738 | fi 739 | 740 | if [ -f ".apikey" ]; then 741 | apikey_exists=true 742 | echo -e "${SUCCESS}✓ .apikey file already exists${NC}" 743 | fi 744 | 745 | # Handle docker-compose.yml 746 | if [ "$compose_exists" = "true" ]; then 747 | echo -e "${WARNING}Docker Compose file already exists.${NC}" 748 | read -p "Do you want to update it? (y/n): " update_compose 749 | if [[ "$update_compose" =~ ^[Yy]$ ]]; then 750 | if ! download_compose_file; then 751 | echo -e "${ERROR}Installation cancelled.${NC}" 752 | exit 1 753 | fi 754 | else 755 | echo -e "${INFO}Using existing docker-compose.yml${NC}" 756 | fi 757 | else 758 | # Download Docker Compose file 759 | if ! download_compose_file; then 760 | echo -e "${ERROR}Installation cancelled.${NC}" 761 | exit 1 762 | fi 763 | fi 764 | 765 | # Handle .env configuration 766 | if [ "$env_exists" = "true" ]; then 767 | echo -e "${WARNING}.env file already exists.${NC}" 768 | echo -e "${INFO}Current configuration:${NC}" 769 | if [ -f ".env" ]; then 770 | source .env 771 | echo -e " ${SUCCESS}APP_URL:${NC} ${APP_URL}" 772 | echo -e " ${SUCCESS}Management UI Port:${NC} ${SLS_MGNT_PORT}" 773 | echo -e " ${SUCCESS}SRTla Port:${NC} ${SRTLA_PORT}" 774 | echo -e " ${SUCCESS}SRT Sender Port:${NC} ${SRT_SENDER_PORT}" 775 | echo -e " ${SUCCESS}SRT Player Port:${NC} ${SRT_PLAYER_PORT}" 776 | echo -e " ${SUCCESS}Statistics Port:${NC} ${SLS_STATS_PORT}" 777 | fi 778 | echo 779 | read -p "Do you want to reconfigure? (y/n): " reconfigure 780 | if [[ "$reconfigure" =~ ^[Yy]$ ]]; then 781 | configure_environment 782 | else 783 | echo -e "${INFO}Using existing .env configuration${NC}" 784 | fi 785 | else 786 | configure_environment 787 | fi 788 | 789 | # Handle data directory 790 | if [ "$data_exists" = "false" ]; then 791 | if ! create_data_directory; then 792 | echo -e "${ERROR}Failed to create data directory properly.${NC}" 793 | echo -e "${WARNING}Docker might create it automatically when starting, but permissions may be incorrect.${NC}" 794 | read -p "Do you want to continue anyway? (y/n): " continue_anyway 795 | if [[ ! "$continue_anyway" =~ ^[Yy]$ ]]; then 796 | echo -e "${ERROR}Installation cancelled.${NC}" 797 | exit 1 798 | fi 799 | fi 800 | else 801 | echo -e "${SUCCESS}Using existing data directory${NC}" 802 | # Still check and potentially fix ownership 803 | create_data_directory >/dev/null 2>&1 || true 804 | fi 805 | 806 | # Start services 807 | echo -e "${INFO}Starting SRTla-Receiver...${NC}" 808 | start_receiver 809 | 810 | # API key is automatically extracted by start_receiver if needed 811 | if [ -f ".apikey" ]; then 812 | echo -e "${SUCCESS}API key is ready in .apikey file${NC}" 813 | else 814 | echo -e "${WARNING}API key could not be extracted automatically.${NC}" 815 | echo -e "${WARNING}Check container logs or try manually: './receiver.sh status'${NC}" 816 | fi 817 | 818 | echo -e "${INFO}Installation/Update successfully completed!${NC}" 819 | echo -e "${WARNING}Use the API key from .apikey for authentication.${NC}" 820 | } 821 | 822 | # Function to configure environment variables 823 | configure_environment() { 824 | # Get public IP 825 | public_ip=$(get_public_ip) 826 | 827 | # Ask for URL 828 | echo -e "${WARNING}Under which address should the management interface be reachable?${NC}" 829 | echo -e "${INFO}Default: $public_ip${NC}" 830 | read -p "Enter URL/IP (or press Enter for default): " user_input 831 | if [ -z "$user_input" ]; then 832 | user_input="$public_ip" 833 | fi 834 | 835 | # Ask for ports 836 | echo -e "${WARNING}Port configuration:${NC}" 837 | 838 | read -p "Management UI Port (default: 3000): " sls_mgnt_port 839 | sls_mgnt_port=${sls_mgnt_port:-3000} 840 | 841 | read -p "SRTla Port (default: 5000): " srtla_port 842 | srtla_port=${srtla_port:-5000} 843 | 844 | read -p "SRT Sender Port (default: 4001): " srt_sender_port 845 | srt_sender_port=${srt_sender_port:-4001} 846 | 847 | read -p "SRT Player Port (default: 4000): " srt_player_port 848 | srt_player_port=${srt_player_port:-4000} 849 | 850 | read -p "Statistics Port (default: 8080): " sls_stats_port 851 | sls_stats_port=${sls_stats_port:-8080} 852 | 853 | # Create APP_URL based on user input 854 | # Check if user already provided a port 855 | if [[ "$user_input" == *":"* ]]; then 856 | # Port already included 857 | app_url="http://$user_input" 858 | else 859 | # No port provided, use statistics port (backend API) 860 | app_url="http://$user_input:$sls_stats_port" 861 | fi 862 | 863 | # Create .env file 864 | create_env_file "$app_url" "$sls_mgnt_port" "$srt_player_port" "$srt_sender_port" "$sls_stats_port" "$srtla_port" 865 | } 866 | 867 | # Parse branch arguments and get filtered command line arguments 868 | filtered_args=() 869 | for arg in "$@"; do 870 | case "$arg" in 871 | --branch=*) 872 | SELECTED_BRANCH="${arg#*=}" 873 | ;; 874 | --use-next) 875 | SELECTED_BRANCH="next" 876 | ;; 877 | --use-main) 878 | SELECTED_BRANCH="main" 879 | ;; 880 | *) 881 | filtered_args+=("$arg") 882 | ;; 883 | esac 884 | done 885 | 886 | # Set positional parameters to filtered arguments 887 | set -- "${filtered_args[@]}" 888 | 889 | # Main logic with positional parameters 890 | case "$1" in 891 | install) 892 | interactive_install 893 | ;; 894 | start) 895 | start_receiver 896 | ;; 897 | stop) 898 | stop_receiver 899 | ;; 900 | update) 901 | update_receiver 902 | ;; 903 | updateself) 904 | update_self 905 | ;; 906 | remove) 907 | remove_container 908 | ;; 909 | status) 910 | show_status 911 | ;; 912 | reset) 913 | check_docker 914 | reset_system 915 | ;; 916 | help|--help|-h) 917 | show_help 918 | ;; 919 | *) 920 | if [ -n "$1" ]; then 921 | echo -e "${ERROR}Unknown command: ${HIGHLIGHT}$1${NC}" 922 | else 923 | echo -e "${INFO}No command specified.${NC}" 924 | fi 925 | show_help 926 | exit 1 927 | ;; 928 | esac 929 | 930 | exit 0 -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . --------------------------------------------------------------------------------