]> git.p6c8.net - policy-templates.git/blobdiff - README.md
Apply suggestion from @bsmth
[policy-templates.git] / README.md
index 34d0bf5473565b06c3924af54e09e0e36b85001a..0e8d7a4cb2cfe8ec6fb4018314c12d8b60df3042 100644 (file)
--- a/README.md
+++ b/README.md
-Policies can either be specified using the GPO templates or by putting a file called policies.json in the distribution directory.
-The content of the JSON file should look like this:
-```
-{
-  "policies": {
-    ...POLICIES...
-  }
-}
-```
-Policies are documented below.
+# Firefox Policy Templates
 
-### BlockAboutAddons
-This policy removes access to about:addons.
-```
-{
-  "policies": {
-    "BlockAboutAddons": true
-  }
-}
-```
-### BlockAboutConfig
-This policy removes access to about:config.
-```
-{
-  "policies": {
-    "BlockAboutConfig": true
-  }
-}
-```
-### BlockAboutSupport
-This policy removes access to about:support.
-```
-{
-  "policies": {
-    "BlockAboutSupport": true
-}
-```
-### BlockSetDesktopBackground
-This policy removes the "Set As Desktop Background..." menuitem when right clicking on an image.
-```
-{
-  "policies": {
-    "BlockAboutSupport": true
-  }
-}
-```
-### CreateMasterPassword
-This policy removes the master password functionality.
-```
-{
-  "policies": {
-    "CreateMasterPassword": false
-  }
-}
-```
-### DisableAppUpdate
-This policy turns off application updates.
-```
-{
-  "policies": {
-    "DisableAppUpdate": true
-  }
-}
-```
-### DisableBuiltinPDFViewer
-This policy disables the built in PDF viewer. PDF files are downloaded and sent externally.
-```
-{
-  "policies": {
-    "DisableBuiltinPDFViewer": true
-  }
-}
-```
-### DisableDeveloperTools
-This policy removes access to all developer tools.
-```
-{
-  "policies": {
-    "DisableDeveloperTools": true
-  }
-}
-```
-### DisableFeedbackCommands
-This policy disables the menus for reporting sites (Submit Feedback, Report Deceptive Site)
-```
-{
-  "policies": {
-    "DisableFeedbackCommands": true
-  }
-}
-```
-### DisableFirefoxScreenshots
-This policy removes access to Firefox Screenshots
-```
-{
-  "policies": {
-    "DisableFirefoxScreenshots": true
-  }
-}
-```
-### DisableFirefoxAccounts
-This policy disables Sync
-```
-{
-  "policies": {
-    "DisableFirefoxAccounts": true
-  }
-}
-```
-### DisableFirefoxStudies
-This policy disables Firefox studies (Shield)
-```
-{
-  "policies": {
-    "DisableFirefoxAccounts": true
-  }
-}
-```
-### DisableFormHistory
-This policy turns off the browser.formfill.enable preferences
-```
-{
-  "policies": {
-    "DisableFormHistory": true
-  }
-}
-```
-### DisablePocket
-This policy turns off Pocket
-```
-{
-  "policies": {
-    "DisablePocket": true
-  }
-}
-```
-### DisablePrivateBrowsing
-This policy removes access to private browsing
-```
-{
-  "policies": {
-    "DisablePrivateBrowsing": true
-  }
-}
-```
-### DisableSafeMode
-This policy disables safe mode on Windows only
-```
-{
-  "policies": {
-    "DisableSafeMode": true
-  }
-}
-```
-### DisableSysAddonUpdate
-This policy prevents system add-ons from being updated or installed.
-```
-{
-  "policies": {
-    "DisableSysAddonUpdate": true
-  }
-}
-```
-### DisplayBookmarksToolbar
-This policy turns on the bookmarks toolbar by default. A user can still turn it off and it will stay off.
-```
-{
-  "policies": {
-    "DisplayBookmarksToolbar": true
-  }
-}
-```
-### DisplayMenuBar
-This policy turns on the menubar by default. A user can still turn it off and it will stay off.
-```
-{
-  "policies": {
-    "DisplayMenuBar": true
-  }
-}
-```
-### DontCheckDefaultBrowser
-This policy stops Firefox from checking if it is the default browser at startup.
-```
-{
-  "policies": {
-    "DontCheckDefaultBrowser": true
-  }
-}
-```
-### EnableTrackingProtection
-This policy affects tracking protection.
+> [!NOTE]
+> These policies are in active development and may contain changes that do not work with current versions of Firefox.
+> Use the [officially released versions](https://github.com/mozilla/policy-templates/releases) if you are deploying changes.
 
-If this policy is not configured, tracking protection is not enabled by default in the browser but it is enabled by default in private browsing and the user can change it.
+This repository contains policy templates to support deploying and managing Firefox as an enterprise browser.
 
-If Value is set to false, tracking protection is disabled and locked in both the browser and private browsing.
+Firefox policies allow administrators to centrally manage browser behavior, enforce security requirements, configure features, or disable certain functionality.
+Policies are commonly used in enterprise or managed environments such as businesses, schools, and public-sector organizations.
 
-If Value is set to true, private browsing is enabled by default in both the browser and private browsing and you can choose set the Locked value if you want to prevent the user from changing it.
-```
-{
-  "policies": {
-    "EnableTrackingProtection": {
-      "Value": [true, false],
-      "Locked": [true, false]
-    }
-  }
-}
-```
-### RememberPasswords
-This policy sets the signon.rememberSignons preference. It can either be enabled or disabled.
-```
-{
-  "policies": {
-    "RememberPasswords": true
-  }
-}
-```
-### Homepage
-This policy sets the default homepage value. It can also be used to lock the homepage and add additional homepages.
-```
-{
-  "policies": {
-    "Homepage": {
-      "URL": "http://example.com/",
-      "Locked": true,
-      "Additional": ["http://example.org/",
-                     "http://example.edu/"]
-    }
-  }
-}
-```
-### Popups
-This policy sets domains for which popups are allowed
-```
-{
-  "policies": {
-    "Popups": {
-      "Allow": ["http://example.org/",
-                "http://example.edu/"]
-    }
-  }
-}
-```
-### InstallAddons
-This policy sets domains that can install extensions
-```
-{
-  "policies": {
-    "InstallAddons": {
-      "Allow": ["http://example.org/",
-                "http://example.edu/"]
-    }
-  }
-}
-```
-### Cookies
-This policy sets domains that can set or not set cookies.
-```
-{
-  "policies": {
-    "Cookies": {
-      "Allow": ["http://example.org/"],
-      "Block": ["http://example.edu/"]
-    }
-  }
-}
-```
-### FlashPlugin
-This policy sets domains that can use or not use Flash
-```
-{
-  "policies": {
-    "FlashPlugin": {
-      "Allow": ["http://example.org/"],
-      "Block": ["http://example.edu/"]
-    }
-  }
-}
-```
-### Bookmarks
-This policy allows you to specify bookmarks. You can have any number of bookmarks although only ten are specified in the ADMX file.
-Placement can be specified as either toolbar or menu. If a folder is specified, it is automatically created and bookmarks with the
-same folder name are grouped together.
+## Policy documentation
 
-```
-{
-  "policies": {
-    "Bookmarks": [
-    {"Title": "Example",
-     "URL": "http://example.org",
-     "Favicon": "http://example.com/favicon.ico",
-     "Placement": "toolbar",
-     "Folder": "Bookmarks"
-     }
-    ]
-  }
-}
-```
+> [!WARNING]
+> Documentation for policy behavior and syntax is moving to [Firefox Admin Docs](https://firefox-admin-docs.mozilla.org/reference/policies/).
+
+The new docs repository is public and open to contributions, so if you want to make improvements, feel free to contribute at https://github.com/mozilla/enterprise-admin-reference.
+See the [GitHub Discussion](https://github.com/mozilla/policy-templates/discussions/1291) for more information.

patrick-canterino.de