Documentation

Réglages avancés

Quelques réglages ne se font pas à l’écran, mais dans un fichier texte ou par une commande.

Avant de commencer : savoir ouvrir le Bloc-notes et PowerShell ; pour la règle de pare-feu, le droit d’administrateur sur ce PC.

Le fichier de configuration

Le fichier s’appelle config.yaml. D’ordinaire, il est dans %LOCALAPPDATA%\Noviscan : collez ce chemin dans la barre d’adresse de l’Explorateur. Si vous avez choisi un autre dossier de données, son chemin est dans data_location.txt, au même endroit.

Un modèle commenté est installé dans C:\Program Files\Noviscan\config.yaml.template, mais il est incomplet : recopiez les lignes de cette page.

C’est du YAML, avec des sections décalées de deux espaces, sans tabulation. Si une section existe déjà, ajoutez-y vos lignes au lieu d’en créer une seconde.

Noviscan ne relit ce fichier qu’au démarrage. Fermez sa fenêtre avant de le modifier, puis rouvrez-la. Noviscan n’est pas un service Windows : fermer la fenêtre suffit.

Ouvrir l’accès depuis votre réseau

Au départ, Noviscan n’écoute que sur le PC qui l’héberge. Pour qu’un téléphone ou un autre poste le joigne, ajoutez ces lignes à config.yaml, puis fermez et rouvrez Noviscan.

api:
  host: 0.0.0.0

0.0.0.0 veut dire « toutes les cartes réseau de ce PC ».

Windows doit aussi laisser passer les connexions. Si Noviscan tourne en administrateur, il ouvre le port lui-même. Sinon, ouvrez PowerShell en administrateur, sur ce PC. La première ligne compte : la commande lit config.yaml dans le dossier où vous êtes, et si vos données sont ailleurs, changez ce chemin. Tapez :

Set-Location "$env:LOCALAPPDATA\Noviscan"
& "$env:ProgramFiles\Noviscan\noviscan.dist\Noviscan.exe" firewall-allow

La commande répond « ✓ » quand la règle est posée, et « ✗ Droits administrateur requis » quand elle ne l’est pas.

Pour vérifier, créez un appairage de téléphone (Premium, voir Utiliser Noviscan sur votre téléphone) : le message rouge L’API n’écoute qu’en local ne doit plus s’afficher.

Recevoir les alertes ailleurs

Le courriel est ouvert à tous les plans. Telegram, Discord, Slack et le webhook (un message envoyé à une adresse web que vous indiquez) demandent Premium. Dans Paramètres, onglet Général, la section Canaux de notification actifs (administrateurs seulement) propose trois cases : console, fichier et E-mail (SMTP, voir config.yaml). Les autres canaux ne s’y trouvent pas.

Le réglage Accès Internet ne coupe pas ces envois.

Le courriel

Dans config.yaml, avec vos valeurs :

notifications:
  smtp_host: smtp.exemple.fr
  smtp_port: 587
  smtp_username: alertes@exemple.fr
  smtp_password_env: MOT_DE_PASSE_ALERTES
  smtp_use_tls: true
  email_from: alertes@exemple.fr
  email_to: [moi@exemple.fr]

smtp_password_env est le nom d’une variable d’environnement Windows qui contient le mot de passe, et elle doit exister avant le lancement de Noviscan. Sinon, smtp_password prend le mot de passe directement, en clair dans le fichier. Rouvrez Noviscan, puis cochez E-mail (SMTP, voir config.yaml). Ces réglages servent aussi à envoyer les invitations (voir Administrer : comptes, mises à jour, journaux).

Telegram, Discord, Slack, webhook

Sous notifications:, ajoutez les lignes du canal, puis son nom dans channels, par exemple channels: [console, desktop, telegram]. Gardez console et desktop pour la notification de bureau Windows. Mettez vos valeurs entre guillemets, comme telegram_chat_id: "-1000000000".

Canal Lignes à ajouter
Telegram telegram_bot_token ou telegram_bot_token_env, et telegram_chat_id
Discord discord_webhook_url ou discord_webhook_url_env
Slack slack_webhook_url ou slack_webhook_url_env
Webhook webhook_url ou webhook_url_env, et en option webhook_secret ou webhook_secret_env

Les adresses de Discord, Slack et du webhook doivent commencer par https:// et mener à un site public, pas à un appareil de votre réseau.

⚠️ Un canal listé sans ses réglages, ou une adresse refusée, peut empêcher Noviscan de démarrer. Écrivez d’abord les réglages, puis le nom du canal. Si Noviscan ne démarre plus, retirez ce nom.

Essayer un canal

Dans PowerShell :

Set-Location "$env:LOCALAPPDATA\Noviscan"
& "$env:ProgramFiles\Noviscan\noviscan.dist\Noviscan.exe" test-notify --channel email

Remplacez email par telegram, discord, slack ou webhook. Un échec du courriel n’apparaît que dans les journaux (Paramètres, onglet Journaux) : vérifiez que le message est arrivé.

Caméras particulières

Ces types se choisissent dans Type de source (voir Ajouter une caméra ou un dossier).

  • Caméra Google Nest (SDM). Créez d’abord un projet Google Device Access. Le formulaire demande ID du projet Device Access, ID client OAuth, Secret client OAuth et Abonnement Pub/Sub. Laissez URI de redirection OAuth tel quel.
  • Caméra Ezviz (clips cloud). Remplissez Numéro de série, Identifiant du compte, Mot de passe du compte et Clé de déchiffrement des clips. Cliquez ensuite sur Authentifier : Ezviz peut envoyer un code par courriel.
  • Freebox — enregistrements caméra. Cliquez sur Ajouter et authentifier, puis validez sur l’écran de la box, avec sa télécommande.
  • SFTP et FTP hors de votre réseau local. Cochez Je confirme vouloir joindre ce serveur distant.

Une caméra peut répondre au test et ne plus rien produire. Le champ Alerter si aucun média après (heures), dans le formulaire de la source, écran Sources, prévient dans ce cas : passé ce délai sans média, la source devient Inactive et Noviscan vous le signale. Laissez-le vide si vous hésitez.

Purger les sessions expirées

Le nettoyage quotidien de Noviscan ne touche pas les sessions expirées : seule la commande Noviscan.exe purge les supprime. Elle applique aussi les durées de conservation décrites dans Combien de temps Noviscan garde quoi. Fermez Noviscan, puis dans PowerShell :

Set-Location "$env:LOCALAPPDATA\Noviscan"
& "$env:ProgramFiles\Noviscan\noviscan.dist\Noviscan.exe" purge --dry-run

Avec --dry-run, rien n’est supprimé ; l’aperçu ne porte que sur les médias et l’historique, pas sur les sessions. Relancez sans cette option pour purger vraiment.

Si ça ne marche pas

  • Noviscan ne démarre plus : annulez votre dernière modification de config.yaml, ou retirez le nom de canal ajouté.
  • Un téléphone ne joint pas Noviscan : avez-vous rouvert Noviscan après avoir changé api ? Puis vérifiez le pare-feu.

Autres cas : Résoudre un problème et obtenir de l’aide.

Vaut pour Noviscan 1.0.0