diff --git a/.github/workflows/build_and_publish_all_images.yaml b/.github/workflows/build_and_publish_all_images.yaml index 28675ff2..496449be 100644 --- a/.github/workflows/build_and_publish_all_images.yaml +++ b/.github/workflows/build_and_publish_all_images.yaml @@ -7,7 +7,7 @@ name: Build & publish all images on: push: branches: - - master + - main paths: - ".github/workflows/build_and_publish_all_images.yaml" - ".github/actions/build_and_publish_image/action.yaml" diff --git a/.github/workflows/build_and_publish_changed_images.yaml b/.github/workflows/build_and_publish_changed_images.yaml index 01cd1865..bf64103d 100644 --- a/.github/workflows/build_and_publish_changed_images.yaml +++ b/.github/workflows/build_and_publish_changed_images.yaml @@ -7,9 +7,9 @@ name: Build & publish changed images on: push: branches: - - master + - main pull_request: - branches: master + branches: main paths-ignore: - README.md - .devconttainer/** diff --git a/.github/workflows/publish_release.yaml b/.github/workflows/publish_release.yaml index 10c0a128..d18f27c0 100644 --- a/.github/workflows/publish_release.yaml +++ b/.github/workflows/publish_release.yaml @@ -20,7 +20,7 @@ jobs: RELEASE_VERSION: ${{ github.ref_name }} run: | # If ref name does not match semver, default to 0.0.0. - # This happens when running from a branch name like master. + # This happens when running from a branch name like main. if [[ ${RELEASE_VERSION} =~ ^v[0-9]+\.[0-9]+\.[0-9]+ ]]; then echo semver=${RELEASE_VERSION/v/} >> $GITHUB_OUTPUT else diff --git a/Dockerfile.example b/Dockerfile.example index feb0b602..d8317106 100644 --- a/Dockerfile.example +++ b/Dockerfile.example @@ -5,9 +5,9 @@ # Supported base images: ubuntu:22.04, ubuntu:20.04 ARG UBUNTU_RELEASE=22.04 ARG GSTREAMER_BASE_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gstreamer -ARG GSTREAMER_BASE_IMAGE_RELEASE=master -ARG PY_BUILD_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/py-build:master -ARG WEB_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gst-web:master +ARG GSTREAMER_BASE_IMAGE_RELEASE=main +ARG PY_BUILD_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/py-build:main +ARG WEB_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gst-web:main FROM ${GSTREAMER_BASE_IMAGE}:${GSTREAMER_BASE_IMAGE_RELEASE}-ubuntu${UBUNTU_RELEASE} as selkies-gstreamer FROM ${PY_BUILD_IMAGE} as selkies-build FROM ${WEB_IMAGE} as selkies-web diff --git a/README.md b/README.md index 85e194ed..3c9d65b2 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Example Google Compute Engine/Google Kubernetes Engine deployment configurations An example image [`ghcr.io/selkies-project/selkies-gstreamer/gst-py-example`](https://github.com/selkies-project/selkies-gstreamer/pkgs/container/selkies-gstreamer%2Fgst-py-example) from the base [example Dockerfile](./Dockerfile.example) is available. -Run the Docker container built from the [`Dockerfile.example`](./Dockerfile.example), then connect to port **8080** of your Docker host to access the web interface (**replace `latest` to `master` for the development build instead of the release build, and choose the Ubuntu versions `20.04`, or `22.04`**): +Run the Docker container built from the [`Dockerfile.example`](./Dockerfile.example), then connect to port **8080** of your Docker host to access the web interface (**replace `latest` to `main` for the development build instead of the release build, and choose the Ubuntu versions `20.04`, or `22.04`**): ```bash docker run --name selkies -it --rm -p 8080:8080 ghcr.io/selkies-project/selkies-gstreamer/gst-py-example:latest-ubuntu20.04 @@ -138,7 +138,7 @@ selkies-gstreamer & ### Install the latest build on a standalone machine or cloud instance -Docker (or an equivalent) is required if you are to use builds from the latest commit. Refer to the above section for more granular informations. This method can be also used when building a new container image with the `FROM [--platform=] [AS ]` and `COPY [--from=] ` instruction instead of using the `docker` CLI. **Change `master` to `latest` if you want the latest release version instead of the latest development version.** +Docker (or an equivalent) is required if you are to use builds from the latest commit. Refer to the above section for more granular informations. This method can be also used when building a new container image with the `FROM [--platform=] [AS ]` and `COPY [--from=] ` instruction instead of using the `docker` CLI. **Change `main` to `latest` if you want the latest release version instead of the latest development version.** **NOTE: You will need to use an external STUN/TURN server capable of `srflx` or `relay` type ICE connections if both your server and client have ports closed or are under a restrictive firewall. Either open the TCP and UDP port ranges 49152-65535 of your server, or follow the instructions from [Using a TURN server](#using-a-turn-server) in order to make the container work using an external TURN server.** @@ -161,8 +161,8 @@ If using supported NVIDIA GPUs, install NVENC (bundled with the GPU driver) and 2. Copy the GStreamer build from the container image and move it to `/opt/gstreamer` (change the OS version `UBUNTU_RELEASE` as needed): ```bash -docker pull ghcr.io/selkies-project/selkies-gstreamer/gstreamer:master-ubuntu${UBUNTU_RELEASE} -docker create --name gstreamer ghcr.io/selkies-project/selkies-gstreamer/gstreamer:master-ubuntu${UBUNTU_RELEASE} +docker pull ghcr.io/selkies-project/selkies-gstreamer/gstreamer:main-ubuntu${UBUNTU_RELEASE} +docker create --name gstreamer ghcr.io/selkies-project/selkies-gstreamer/gstreamer:main-ubuntu${UBUNTU_RELEASE} sudo docker cp gstreamer:/opt/gstreamer /opt/gstreamer docker rm gstreamer ``` @@ -172,8 +172,8 @@ This will install the GStreamer components to the default directory of `/opt/gst 3. Copy the Python Wheel file from the container image and install it: ```bash -docker pull ghcr.io/selkies-project/selkies-gstreamer/py-build:master -docker create --name selkies-py ghcr.io/selkies-project/selkies-gstreamer/py-build:master +docker pull ghcr.io/selkies-project/selkies-gstreamer/py-build:main +docker create --name selkies-py ghcr.io/selkies-project/selkies-gstreamer/py-build:main docker cp selkies-py:/opt/pypi/dist/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl docker rm selkies-py sudo pip3 install /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl @@ -183,8 +183,8 @@ rm -f /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl 4. Install the HTML5 components to the container image: ```bash -docker pull ghcr.io/selkies-project/selkies-gstreamer/gst-web:master -docker create --name gst-web ghcr.io/selkies-project/selkies-gstreamer/gst-web:master +docker pull ghcr.io/selkies-project/selkies-gstreamer/gst-web:main +docker create --name gst-web ghcr.io/selkies-project/selkies-gstreamer/gst-web:main sudo docker cp gst-web:/usr/share/nginx/html /opt/gst-web docker rm gst-web ``` diff --git a/addons/gst-web/src/signalling.js b/addons/gst-web/src/signalling.js index 144e625f..f3d4e2b0 100644 --- a/addons/gst-web/src/signalling.js +++ b/addons/gst-web/src/signalling.js @@ -36,13 +36,13 @@ class WebRTCDemoSignalling { /** * Interface to WebRTC demo signalling server. - * Protocol: https://github.com/centricular/gstwebrtc-demos/blob/master/signalling/Protocol.md + * Protocol: https://github.com/GStreamer/gstreamer/blob/main/subprojects/gst-examples/webrtc/signalling/Protocol.md * * @constructor * @param {URL} [server] * The URL object of the signalling server to connect to, created with `new URL()`. * Signalling implementation is here: - * https://github.com/centricular/gstwebrtc-demos/tree/master/signalling + * https://github.com/GStreamer/gstreamer/tree/main/subprojects/gst-examples/webrtc/signalling * @param {number} [peer_id] * The peer ID established during signalling that the sending peer (server) will connect to. * This can be anything, but must match what the server will attempt to connect to. diff --git a/docker-compose.yaml b/docker-compose.yaml index 43196039..61f9ce03 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -35,7 +35,7 @@ services: # 2. export GSTREAMER_BASE_IMAGE=gstreamer # 3. docker-compose build test GSTREAMER_BASE_IMAGE: ${GSTREAMER_BASE_IMAGE:-ghcr.io/selkies-project/selkies-gstreamer/gstreamer} - GSTREAMER_BASE_IMAGE_RELEASE: ${GSTREAMER_BASE_IMAGE_RELEASE:-master} + GSTREAMER_BASE_IMAGE_RELEASE: ${GSTREAMER_BASE_IMAGE_RELEASE:-main} PY_BUILD_IMAGE: selkies-gstreamer-py-build:latest WEB_IMAGE: gst-web:latest diff --git a/infra/gke/manifests/coturn/kustomization.yaml b/infra/gke/manifests/coturn/kustomization.yaml index ff18d02b..6eec8f74 100644 --- a/infra/gke/manifests/coturn/kustomization.yaml +++ b/infra/gke/manifests/coturn/kustomization.yaml @@ -30,7 +30,7 @@ resources: images: - name: ghcr.io/selkies-project/selkies-gstreamer/coturn newName: ghcr.io/selkies-project/selkies-gstreamer/coturn - newTag: master + newTag: main - name: ghcr.io/selkies-project/selkies-gstreamer/coturn-web newName: ghcr.io/selkies-project/selkies-gstreamer/coturn-web - newTag: master \ No newline at end of file + newTag: main \ No newline at end of file diff --git a/src/selkies_gstreamer/webrtc_signalling.py b/src/selkies_gstreamer/webrtc_signalling.py index 674df0b5..59d3b3b8 100644 --- a/src/selkies_gstreamer/webrtc_signalling.py +++ b/src/selkies_gstreamer/webrtc_signalling.py @@ -32,7 +32,7 @@ """Signalling API for Gstreamer WebRTC demo Interfaces with signalling server found at: - https://github.com/centricular/gstwebrtc-demos/tree/master/signalling + https://github.com/GStreamer/gstreamer/tree/main/subprojects/gst-examples/webrtc/signalling Usage example: from webrtc_signalling import WebRTCSignalling