Personnalisation de Parsec

L’application Parsec peut être partiellement personnalisée pour mieux correspondre à votre marque.

La personnalisation se fait en ajoutant des fichiers spécifiques à certains emplacements. Si Parsec détecte la présence de ces fichiers, il les utilisera à la place des fichiers habituels.

Application native

L’application de bureau Parsec recherche toujours les fichiers de personnalisation au démarrage. Les fichiers doivent être placés dans un dossier custom dans le répertoire de configuration. Le répertoire de configuration dépend du système d’exploitation :

Windows : %APPDATA%/parsec3/app
Linux : ~/.config/parsec3/app
MacOS : ~/Library/Application Support/parsec3/app

Application web

En mode web, les fichiers doivent être placés dans un dossier custom dans le répertoire de fichiers statiques du serveur. Un fichier doit être accessible via /custom/<file> sur le serveur.

De plus, le serveur doit activer la personnalisation en définissant l’attribut content de la balise <meta name="custom-branding"> dans le fichier index.html à :

<meta name="custom-branding" content="true,cacheBustingSuffix=<suffix>" />

Où <suffix> est une chaîne arbitraire (typiquement la date de la dernière modification des fichiers de personnalisation) qui est ajoutée aux noms des fichiers de ressources pour le cache busting (par exemple, cacheBustingSuffix=-20240101 signifie que logo-20240101.svg sera récupéré). Ce suffixe doit être mis à jour à chaque modification des fichiers de personnalisation.

Par défaut (c’est-à-dire sans modification), la balise est définie à false, ce qui désactive la personnalisation :

<meta name="custom-branding" content="false" />

Images

Les images suivantes peuvent être personnalisées pour le moment :

logo.svg : le logo affiché dans le coin inférieur gauche de la page d’accueil.
logo_icon.svg : la version icône du logo, elle sera utilisée pour vos organisations.
home_sidebar.png : l’image affichée sur la barre latérale de la page d’accueil.

Spécifiquement pour l’application de bureau sur Linux et Windows, vous pouvez également ajouter :

app_icon.png : l’icône affichée dans la barre des tâches ou dans le titre de la fenêtre.
tray_icon.png : l’icône affichée dans la barre d’état système ou de notifications.
splash.png : l’écran de démarrage de l’application. Nous vous recommandons de respecter la taille de l’écran de démarrage original, qui est de 624x424.

Note

Le type d’image et l’extension de fichier sont importants. Si vous utilisez un type différent, Parsec ne pourra peut-être pas le charger.

Nous vous recommandons de vérifier l’application avec différentes résolutions d’affichage, car certaines images peuvent sembler parfaites sur votre écran, mais complètement décalées sur un autre. Si vous utilisez les tailles recommandées lorsqu’elles sont mentionnées, vous ne devriez pas rencontrer de problème.

Textes

Vous pouvez également personnaliser certains textes dans Parsec. Pour ce faire :

Copiez les extraits .json ci-après dans des fichiers custom_en-US.json et custom_fr-FR.json respectivement
Éditez les textes originaux (mais pas les clefs)
Mettez les deux fichiers ainsi modifiés dans le même dossier custom que précédemment.

{
    "HomePage": {
        "topbar": {
            "welcome": "Welcome to Parsec"
        }
    },
    "MenuPage": {
        "documentationLink": "https://docs.parsec.cloud/en/{version}",
        "documentationGuideLink": "https://docs.parsec.cloud/en/{version}/userguide/{page}.html"
    }
}

{
    "HomePage": {
        "topbar": {
            "welcome": "Bienvenue sur Parsec"
        }
    },
    "MenuPage": {
        "documentationLink": "https://docs.parsec.cloud/fr/{version}",
        "documentationGuideLink": "https://docs.parsec.cloud/fr/{version}/userguide/{page}.html"
    }
}

Emails et pages HTML du serveur

Les courriels du serveur Parsec et les pages HTML (index, 404) sont basés sur la syntaxe de template Jinja.

Vous pouvez les personnaliser en fournissant un répertoire de modèles personnalisé lors de l’exécution du serveur avec --template-dir ou en définissant la variable d’environnement PARSEC_TEMPLATE_DIR.

Le dossier doit contenir les fichiers suivants :

index.html : page d’accueil par défaut lorsque vous accédez au serveur.
404.html : page de ressource non trouvée.
email/account_create.[html|txt].j2 : Modèles HTML et TEXTE pour le courriel envoyé afin de confirmer la création d’un compte Parsec.
email/account_delete.[html|txt].j2: Modèles d’e-mail HTML et TEXTE pour confirmer la suppression du compte Parsec.
email/account_recover.[html|txt].j2 : modèles d’e-mails HTML et TEXTE pour confirmer la récupération du compte Parsec.
email/invitation.[html|txt].j2 : modèles d’e-mails HTML et TEXTE pour envoyer une invitation à rejoindre une organisation.

Note

Vous pouvez baser votre personnalisation sur les modèles du serveur par défaut disponibles ici.