Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Warn the admin when no High-performance backend is set up #14063

Merged
merged 3 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/internal-signaling.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ Todo

### External signaling API

See [External signaling API](https://nextcloud-spreed-signaling.readthedocs.io/en/latest/) for the Signaling API of the High-Performance Backend.
See [External signaling API](https://nextcloud-spreed-signaling.readthedocs.io/en/latest/) for the Signaling API of the High-performance backend.
2 changes: 1 addition & 1 deletion lib/SetupCheck/Configuration.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public function getCategory(): string {
}

public function getName(): string {
return $this->l10n->t('Talk configuration');
return $this->l10n->t('Talk configuration values');
}

public function run(): SetupResult {
Expand Down
5 changes: 4 additions & 1 deletion lib/SetupCheck/HighPerformanceBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,10 @@ public function getName(): string {

public function run(): SetupResult {
if ($this->talkConfig->getSignalingMode() === Config::SIGNALING_INTERNAL) {
return SetupResult::success();
return SetupResult::error(
$this->l->t('No High-performance backend configured - Running Nextcloud Talk without the High-performance backend only scales for very small calls (max. 2-3 participants). Please set up the High-performance backend to ensure calls with multiple participants work seamlessly.'),
'https://portal.nextcloud.com/article/Nextcloud-Talk/High-Performance-Backend/Installation-of-Nextcloud-Talk-High-Performance-Backend',
nickvergessen marked this conversation as resolved.
Show resolved Hide resolved
);
}

if ($this->talkConfig->getSignalingMode() === Config::SIGNALING_CLUSTER_CONVERSATION) {
Expand Down
2 changes: 1 addition & 1 deletion lib/SetupCheck/RecordingBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function run(): SetupResult {
return SetupResult::success();
}
if (empty($this->talkConfig->getRecordingServers())) {
return SetupResult::success();
return SetupResult::info($this->l->t('No recording backend configured'));
}
return SetupResult::error($this->l->t('Using the recording backend requires a High-performance backend.'));
}
Expand Down
2 changes: 1 addition & 1 deletion lib/SetupCheck/SIPConfiguration.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function run(): SetupResult {
return SetupResult::success();
}
if ($this->talkConfig->getSIPSharedSecret() === '' && $this->talkConfig->getDialInInfo() === '') {
return SetupResult::success();
return SetupResult::info($this->l->t('No SIP backend configured'));
}
return SetupResult::error($this->l->t('Using the SIP functionality requires a High-performance backend.'));
}
Expand Down
2 changes: 1 addition & 1 deletion lib/TInitialState.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ protected function publishInitialStateShared(): void {
if ($signalingMode === Config::SIGNALING_CLUSTER_CONVERSATION
&& !$this->memcacheFactory->isAvailable()) {
throw new HintException(
'High Performance Back-end clustering is only supported with a distributed cache!'
'High-performance backend clustering is only supported with a distributed cache!'
);
}

Expand Down
4 changes: 4 additions & 0 deletions src/components/AdminSettings/Federation.vue
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
<small>{{ t('spreed', 'Beta') }}</small>
</h2>

<p class="settings-hint additional-top-margin">
{{ t('spreed', 'Federated chats and calls work already. Attachment handling is coming in a future version.') }}
</p>

<NcCheckboxRadioSwitch :model-value="isFederationEnabled"
:disabled="loading"
type="switch"
Expand Down
2 changes: 1 addition & 1 deletion src/components/AdminSettings/HostedSignalingServer.vue
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
id="hosted_signaling_server"
class="hosted-signaling section">
<h2>
{{ t('spreed', 'Hosted high-performance backend') }}
{{ t('spreed', 'Hosted High-performance backend') }}
</h2>

<p class="settings-hint">
Expand Down
2 changes: 1 addition & 1 deletion src/components/AdminSettings/RecordingServers.vue
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<NcNoteCard v-if="!showForm"
type="warning"
:text="t('spreed', 'Recording backend configuration is only possible with a high-performance backend.')" />
:text="t('spreed', 'Recording backend configuration is only possible with a High-performance backend.')" />

<template v-else>
<NcNoteCard v-if="showUploadLimitWarning" type="warning" :text="uploadLimitWarning" />
Expand Down
2 changes: 1 addition & 1 deletion src/components/AdminSettings/SIPBridge.vue
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

<NcNoteCard v-if="!showForm"
type="warning"
:text="t('spreed', 'SIP configuration is only possible with a high-performance backend.')" />
:text="t('spreed', 'SIP configuration is only possible with a High-performance backend.')" />

<template v-else>
<NcCheckboxRadioSwitch v-model="dialOutEnabled"
Expand Down
45 changes: 26 additions & 19 deletions src/components/AdminSettings/SignalingServers.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,22 @@

<template>
<section id="signaling_server" class="signaling-servers section">
<NcNoteCard v-if="!servers.length"
type="error"
:heading="t('spreed', 'Nextcloud Talk setup not complete')"
:text="t('spreed', 'Install the High-performance backend to ensure calls with multiple participants work seamlessly.')" />

<h2>
{{ t('spreed', 'High-performance backend') }}
</h2>

<p class="settings-hint">
{{ t('spreed', 'An external signaling server should optionally be used for larger installations. Leave empty to use the internal signaling server.') }}
{{ t('spreed', 'The High-performance backend is required for calls and conversations with multiple participants. Without the backend, all participants have to upload their own video individually for each other participant, which will most likely cause connectivity issues and a high load on participating devices.') }}
</p>

<NcNoteCard v-if="!isCacheConfigured"
<NcNoteCard v-if="servers.length && !isCacheConfigured"
type="warning"
:text="t('spreed', 'It is highly recommended to set up a distributed cache when using Nextcloud Talk together with a High Performance Back-end.')" />
:text="t('spreed', 'It is highly recommended to set up a distributed cache when using Nextcloud Talk with a High-performance backend.')" />

<TransitionWrapper v-if="servers.length"
name="fade"
Expand All @@ -40,21 +45,11 @@
<span v-if="loading" class="icon icon-loading-small" />
<Plus v-else :size="20" />
</template>
{{ t('spreed', 'Add a new high-performance backend server') }}
{{ t('spreed', 'Add High-performance backend server') }}
</NcButton>

<template v-if="!servers.length">
<p class="settings-hint additional-top-margin">
{{ t('spreed', 'Please note that in calls with more than 4 participants without external signaling server, participants can experience connectivity issues and cause high load on participating devices.') }}
</p>
<NcCheckboxRadioSwitch v-model="hideWarning"
:disabled="loading"
@update:model-value="updateHideWarning">
{{ t('spreed', 'Don\'t warn about connectivity issues in calls with more than 4 participants') }}
</NcCheckboxRadioSwitch>
</template>

<NcPasswordField v-model="secret"
<NcPasswordField v-if="servers.length"
v-model="secret"
class="form__textfield additional-top-margin"
name="signaling_secret"
as-text
Expand All @@ -63,6 +58,18 @@
:label="t('spreed', 'Shared secret')"
label-visible
@update:model-value="debounceUpdateServers" />

<template v-if="!servers.length">
<NcNoteCard type="warning"
class="additional-top-margin"
:text="t('spreed', 'Please note that in calls with more than 2 participants without the High-performance backend, participants will most likely experience connectivity issues and cause high load on participating devices.')" />
<NcCheckboxRadioSwitch v-model="hideWarning"
:disabled="loading"
@update:model-value="updateHideWarning">
{{ t('spreed', 'Don\'t warn about connectivity issues in calls with more than 2 participants') }}
</NcCheckboxRadioSwitch>
</template>

Check warning on line 71 in src/components/AdminSettings/SignalingServers.vue

View workflow job for this annotation

GitHub Actions / NPM lint

Expected 1 line break before closing tag (`</section>`), but 2 line breaks found

</section>
</template>

Expand Down Expand Up @@ -134,7 +141,7 @@
newServer() {
this.servers.push({
server: '',
verify: false,
verify: true,
})
},

Expand All @@ -143,7 +150,7 @@

OCP.AppConfig.setValue('spreed', 'hide_signaling_warning', this.hideWarning ? 'yes' : 'no', {
success: () => {
showSuccess(t('spreed', 'Missing high-performance backend warning hidden'))
showSuccess(t('spreed', 'Missing High-performance backend warning hidden'))
this.loading = false
this.toggleSave()
},
Expand Down Expand Up @@ -186,6 +193,6 @@
}

.additional-top-margin {
margin-top: 10px;
margin-top: 35px !important;
}
</style>
6 changes: 3 additions & 3 deletions src/views/AdminSettings.vue
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@

<template>
<div>
<SignalingServers />
<HostedSignalingServer />
<GeneralSettings />
<MatterbridgeIntegration />
<AllowedGroups />
<Federation v-if="supportFederation" />
<BotsSettings />
<WebServerSetupChecks />
<StunServers />
<TurnServers />
<SignalingServers />
<HostedSignalingServer />
<RecordingServers />
<SIPBridge />
<MatterbridgeIntegration />
</div>
</template>

Expand Down
Loading