Les fichiers AutoConfig peuvent être utilisés pour paramétrer et verrouiller les préférences qui ne sont pas garanties par les stratégies de Firefox.
Pour utiliser AutoConfig, vous placez deux fichiers dans les répertoires de Firefox. Sous Windows, ils vont dans le dossier d’installation de Firefox. Sous macOS, ils vont dans le répertoire Contents/Resources de Firefox.app.
Le premier fichier que vous avez besoin de créer se nomme autoconfig.js et se place dans le répertoire defaults/pref. Il devrait contenir les deux lignes suivantes :
pref("general.config.filename", "firefox.cfg");
pref("general.config.obscure_value", 0);
La première ligne donne le nom du fichier AutoConfig. Vous pouvez choisir le nom que vous désirez, mais l'emplacement du fichier ne peut être modifié.
La seconde ligne indique que vous ne voulez pas que le fichier AutoConfig soit obscurci. Par défaut, Firefox attend un décalage de 13 octets dans ce fichier dans le but de le brouiller.
Le second fichier que vous avez besoin de créer est nommé firefox.cfg et doit être placé au niveau supérieur.
Il doit toujours commencer par une ligne de commentaires :
// IMPORTANT : commencez votre code sur la 2e ligne
Bien que l'extension d'un fichier AutoConfig soit typiquement .cfg, le fichier AutoConfig lui-même est un fichier JavaScript. Cela signifie que vous pouvez y écrire du code JavaScript pour obtenir des logiques différentes selon les situations.
Les fonctions suivantes sont disponibles dans un fichier AutoConfig :
pref(prefName, value) – positionne la valeur utilisateur d'une préférence. Cette fonction positionne explicitement la préférence comme une préférence utilisateur. Cela signifie que si l'utilisateur change cette valeur, elle sera repositionnée chaque fois que le navigateur est lancé.
defaultPref(prefName, value) – positionne la valeur par défaut d'une préférence. Il s'agit de la valeur prise par une préférence tant que l'utilisateur ne lui en a pas spécifié une.
lockPref(prefName, value) – positionne la valeur par défaut d'une préférence et la verrouille. C'est la fonction la plus familière à ceux qui utilisent les fichiers AutoConfig. Verrouiller une préférence empêche l'utilisateur de la modifier, et, dans la plupart des cas, désactive l'interface utilisateur dans les options / préférences de façon évidente pour l'utilisateur. Au cas où vous ne voyez rien qui puisse être désactivé dans les options / préférences, voici quelques préférences « disable_button » qui, quand elles sont verrouillées, désactivent des boutons. Par exemple, si vous verrouillez la préférence
pref.privacy.disable_button.view_passwords
cela désactive le bouton « Afficher les mots de passe ». Voici les autres préférences qui verrouillent des boutons :
pref.general.disable_button.default_browser pref.browser.homepage.disable_button.current_page pref.browser.homepage.disable_button.bookmark_page pref.browser.homepage.disable_button.restore_default security.disable_button.openCertManager security.disable_button.openDeviceManager app.update.disable_button.showUpdateHistory pref.privacy.disable_button.cookie_exceptions pref.privacy.disable_button.view_cookies pref.privacy.disable_button.view_passwords pref.privacy.disable_button.view_passwords_exceptions pref.downloads.disable_button.edit_actions
unlockPref(prefName) – déverrouille une préférence. Pour exemple, il peut y avoir des cas où vous verrouillez une préférence pour tout le monde et la déverrouillez pour un utilisateur précis.
getPref(prefName) – retourne la valeur d'une préférence. Si la préférence n'existe pas, cette fonction affiche une erreur. Vous devriez ne l'utiliser que pour des préférences dont vous connaissez l'existence.
clearPref(prefName) – supprime la valeur utilisateur d'une préférence, la repositionnant à sa valeur par défaut.
displayError(funcname, message) – affiche une erreur dans un format spécifique.
Netscape.cfg/AutoConfig failed. Please contact your system administrator. Error: [funcname] failed: [message]
C'est pratique pour le débogage.
getenv(name) – vous permet de récupérer la valeur des variables d'environnement. Cela vous permet de connaître les noms d'utilisateurs et d'autres informations sur le système.
Si vous voulez gérer de façon centralisée votre fichier AutoConfig, vous pouvez spécifier l'emplacement d'un fichier AutoConfig secondaire dans le fichier AutoConfig primaire :
pref("autoadmin.global_config_url","http://yourdomain.com/autoconfigfile.js");
Son URL peut utiliser n'importe quel protocole supporté par Firefox. Cela inclut de spécifier le protocole file: pour pointer vers un fichier situé sur un disque réseau. Le format du fichier autoconfig distant est le même que celui du fichier autoconfig sur le client, excepté que la première ligne n'est pas ignorée.
Si vous désirez obtenir des informations spécifiques aux utilisateurs dans votre configuration, vous pouvez positionner une autre préférence :
pref("autoadmin.append_emailaddr", true);
Cela ajoutera un point d'interrogation (?) et une adresse de courrier électronique à la demande.
Il se peut que vous vous demandiez d'où vient cette adresse électronique. Comme Firefox n'utilise pas d'adresse électronique, vous aurez besoin d'en paramétrer une. Si vous ne le faites pas, Firefox affichera une invite vous demandant l'adresse électronique. La préférence est appelée mail.identity.useremail et est une préférence chaîne de caractères. Comme le fichier autoconfig est un fichier JS, vous pouvez fixer cette préférence avant de positionner autoadmin.global_config_url. Vous pourriez écrire quelque chose comme :
var user = getenv("USER");
lockPref("mail.identity.useremail", user);
lockPref("autoadmin.global_config_url","http://yourdomain.com/autoconfigfile.js");
Il y a quelques autres préférences qui contrôlent des particularités d'AutoConfig. autoadmin.refresh_interval provoque le rafraîchissement d'AutoConfig selon un intervalle donné spécifié en minutes. Il existe aussi quelques préférences relatives à la façon dont le mode hors connexion est géré, comprenant autoadmin.offline_failover et autoadmin.failover_to_cached. Voici comment elles fonctionnent.
À chaque fois qu'un fichier AutoConfig est récupéré à distance, une copie de sauvegarde de ce fichier est créée dans le dossier de profil de l'utilisateur nommée failover.jsc. Si la préférence autoadmin.failover_to_cached est positionnée sur false, Firefox lit le fichier mis en cache, puis marque le navigateur comme hors connexion et verrouille la préférence pour que l'utilisateur ne puisse aller en ligne. Si la préférence est positionnée sur true, il utilise simplement le fichier en cache, puis poursuit. La préférence autoadmin.offline_failover contrôle si, oui ou non, le fichier mis en cache est utilisé quand l'utilisateur est simplement hors connexion. Si elle est positionnée sur true, le fichier en cache est utilisé.
