Skip to content

Commit 21557ee

Browse files
Readme and default updates (#18)
* Change default sync service; readme updates * Credits update * Do not flag an empty cloud-sync hostname as an error if cloud-sync is not used * update release date and package-lock * Update package.json Co-authored-by: Jon Francombe <104007149+bo-jofr@users.noreply.github.com> --------- Co-authored-by: Kristian Hentschel <Kristian.Hentschel@bbc.co.uk>
1 parent 4d9ae26 commit 21557ee

File tree

6 files changed

+17
-12
lines changed

6 files changed

+17
-12
lines changed

Changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
This changelog summarises changes for minor and major version bumps that end users might need to be aware of. The commit log should provide a more detailed list of changes for developers; most changes to internal systems are not discussed here.
44

55
---
6+
# `0.23.3` (public release)
7+
_2026-01-09_
8+
* Remove the default reference to the decomissioned BBC cloud-sync server, and default to PeerJS sync. Minor updates to readme.
9+
610
# `0.23.2` (public release)
711
_2025-01-29_
812
* Update application template, removes BBC logo from footer and updates the "made with Audio Orchestrator" link.

Readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Create a project, import audio files, and author metadata for audio objects, seq
99

1010
_Audio Orchestrator_ requires `ffmpeg` and `ffprobe` to be available in the system path or a specific location in your home directory. For a manual installation, place the binaries in `~/audio-orchestrator-ffmpeg/bin` on macOS and `%HOME%\audio-orchestrator-ffmpeg\bin` on Windows. See the [installation instructions](https://bbc.github.io/audio-orchestrator/installation/) for more details.
1111

12-
**NB** _Audio Orchestrator_ by default uses a synchronisation server [cloud-sync](https://github.com/2-IMMERSE/cloud-sync) hosted by the BBC, which may go away without warning in the future. We recommend replacing this with your own server by setting its URL in the advanced export settings. There are [some notes on running a self-hosted cloud-sync server](https://github.com/bbc/audio-orchestration/issues/64).
12+
**NB** _Audio Orchestrator_ needs to use a synchronisation server, for example, an instance of [cloud-sync](https://github.com/2-IMMERSE/cloud-sync). A cloud-sync instance was previously hosted by the BBC but has been decomissioned and is no longer active as of December 2025. This should be replaced with your own server by setting its URL in the advanced export settings. There are [some notes on running a self-hosted cloud-sync server](https://github.com/bbc/audio-orchestration/issues/64). You could also explore the experimental and unsupported PeerJS synchronisation service, again in the advanced export settings.
1313

1414
# Architecture overview
1515

@@ -23,13 +23,13 @@ Development requires a macOS (or possibly Linux) environment. The instructions h
2323

2424
## Getting started
2525

26-
1. Ensure you have [Node.js](https://nodejs.org/en/) version 20.x+ installed.
26+
1. Ensure you have [Node.js](https://nodejs.org/en/) version 22.x+ installed.
2727

2828
```
29-
node -v # e.g., v20.9.0
29+
node -v # e.g., v22.21.1
3030
```
3131

32-
2. Log in to the GitHub packages NPM registry. Create a [personal access token (classic)](https://github.com/settings/tokens) with only the `read:packages` permission, then log in using your GitHub username and the token as the password:
32+
2. Log in to the GitHub packages NPM registry. To do this, first create a [personal access token (classic)](https://github.com/settings/tokens) with only the `read:packages` permission. Then, log in using your GitHub username and the token as the password:
3333

3434
```
3535
npm login --registry https://npm.pkg.github.com --scope @bbc

electron-app/credits.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</head>
1313
<body>
1414
<h1>About Audio Orchestrator</h1>
15-
<p>Version 0.23.2</p>
15+
<p>Version 0.23.3</p>
1616
<p>Copyright BBC R&amp;D</p>
1717
<p>User guide: https://bbc.github.io/audio-orchestrator</p>
1818
<p>Source code: https://github.com/bbc/audio-orchestrator</p>

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
{
22
"name": "@bbc/audio-orchestrator",
33
"productName": "Audio Orchestrator",
4-
"description": "Audio Orchestrator is an production tool for prototyping multi-device audio experiences.",
4+
"description": "Audio Orchestrator is a production tool for prototyping multi-device audio experiences.",
55
"repository": "https://github.com/bbc/audio-orchestrator",
6-
"version": "0.23.2",
6+
"version": "0.23.3",
77
"author": "BBC R&D",
88
"license": "GPL-3.0-or-later",
99
"private": true,

react-frontend/src/lib/Project.js

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@ const DEFAULT_SETTINGS = {
3434
accentColour: '#006def',
3535
enableDebugUI: true,
3636
enableCalibration: false,
37-
syncEndpointType: 'cloud-sync',
38-
cloudSyncHostname: 'cloudsync.virt.ch.bbc.co.uk',
37+
syncEndpointType: 'peerjs',
38+
cloudSyncHostname: '', // Previously cloudsync.virt.ch.bbc.co.uk, but this is no longer available
3939
customTemplatePath: undefined,
4040
};
4141

@@ -619,9 +619,10 @@ class Project {
619619
const {
620620
joiningLink,
621621
cloudSyncHostname,
622+
syncEndpointType,
622623
} = settings;
623624
const joiningLinkValid = !joiningLink || isUrl(joiningLink);
624-
const cloudSyncHostnameValid = isHostname(cloudSyncHostname);
625+
const cloudSyncHostnameValid = isHostname(cloudSyncHostname) || syncEndpointType !== 'cloud-sync';
625626
const valid = joiningLinkValid && cloudSyncHostnameValid;
626627

627628
let message = null;

0 commit comments

Comments
 (0)