• Skip to main content
  • Select language
  • Skip to search
MDN Web Docs
  • Technologies
    • HTML
    • CSS
    • JavaScript
    • Graphics
    • HTTP
    • APIs / DOM
    • WebExtensions
    • MathML
  • References & Guides
    • Learn web development
    • Tutorials
    • References
    • Developer Guides
    • Accessibility
    • Game development
    • ...more docs
Add-ons
  1. MDN
  2. Mozilla
  3. Add-ons
  4. Browser extensions
  5. Publishing your extension

Publishing your extension

In This Article
  1. 1. Zip up your extension's files
    1. Windows
    2. Mac OS X
    3. Linux / Mac OS X Terminal
  2. 2. Create an account on addons.mozilla.org
  3. 3. Upload your zip
  4. 4. Fix review problems
  5. 5. Publish your extension

Once you've finished writing and testing your extension, you'll probably want to share it with other people. Mozilla operates a website: addons.mozilla.org (commonly abbreviated to AMO), where developers can publish add-ons and users can find them. By publishing your extension on AMO, you can participate in our community of users and creators, and find an audience for your extension.

You don't have to publish your extension on AMO. However, even if you are not intending to publish your extension on AMO, you do have to submit it to AMO so it can be reviewed and signed. Release versions of Firefox will refuse to install extensions that are not signed by AMO.

So the process for publishing an extension is, in outline:

  1. zip up your extension's files
  2. create an account on AMO
  3. upload your zip to AMO for signing and review, and select listing option
  4. fix any problems that are found in review
  5. if you chose not to publish on AMO, retrieve the signed extension, and publish it yourself

When you're ready to release a new version of your extension, you can update it by visiting the extension's page on addons.mozilla.org, and uploading the new version there. Note that you must update it on the extension's page, so AMO recognizes it as an update to an existing extension, and not a brand-new one.

If you chose to publish your extension on AMO, then Firefox will automatically check for updates. If you chose to publish it yourself, you'll need to include the applications key in your manifest.json, with the update_url attribute set to point to an update manifest file.

Packaged extensions in Firefox are called "XPI files", which are just ZIP files with a different extension.

You don't have to use the XPI extension when uploading to AMO.

1. Zip up your extension's files

At this point your extension will consist of a directory containing a manifest.json and any other files it needs - scripts, icons, HTML documents, and so on. You'll need to zip these into a single file for uploading to AMO.

One trick is that the ZIP file must be a ZIP of the extension's files themselves, not of the containing directory.

Windows

  1. Open the folder with your extension's files.
  2. Select all of the files.
  3. Right click and choose Send to → Compressed (zipped) Folder.

Mac OS X

  1. Open the folder with your extension's files.
  2. Select all of the files.
  3. Right click and choose Compress n Items.

See http://www.info-zip.org/mans/zip.html.

Linux / Mac OS X Terminal

  1. cd path/to/my-extension/
  2. zip -r -FS ../my-extension.zip *
 

2. Create an account on addons.mozilla.org

Visit https://addons.mozilla.org/. If you already have a Firefox Account, you can use that to log in. Otherwise, click "Register" and you'll be asked to create a Firefox account.

3. Upload your zip

Next, upload the zipped extension to AMO for signing and review, and choose whether to publish it on AMO or not. A tutorial is available to guide you through the submission process. You may also see Submitting to AMO for submission details.

Note that once you have uploaded your extension to AMO, you can't then update the extension to use the Add-on SDK or legacy XUL/XPCOM techniques. If you do switch to one of these platforms, you must submit it as a completely new extension.

That is: porting from legacy extension systems to use WebExtension APIs is a one-way street.

Before uploading, double-check that the ZIP contains exactly the contents you want to submit, with no extra redundant files.

4. Fix review problems

As soon as you upload the extension, the AMO server will run some basic checks and immediately notify you about any problems. Problems are presented in two categories: "errors" and "warnings". If you have errors, you must fix them and resubmit. If you only have warnings, it's advisable to address them, but not mandatory: you can continue with the submission.

If the automated checker doesn't report any errors, the extension will go for a more detailed review. You'll be contacted with the review results and will need to fix any problems and resubmit.

If you have chosen to have the extension hosted on AMO, this is the end of the publication process. AMO will sign the extension and publish it, and users will then be able to download and install it.

5. Publish your extension

If you chose not to publish on AMO, retrieve the signed extension, and publish it yourself.

 

Document Tags and Contributors

Tags: 
  • WebExtensions
 Contributors to this page: andrewtruongmoz, julienw, hellosct1, bunnybooboo, wbamberg, mrj
 Last updated by: andrewtruongmoz, Jul 19, 2017, 10:50:55 AM
See also
  1. Browser extensions
  2. Getting started
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
  3. How to
    1. Intercept HTTP requests
    2. Modify a web page
    3. Add a button to the toolbar
    4. Implement a settings page
  4. User interface
    1. Introduction
    2. Toolbar button
    3. Address bar button
    4. Sidebar
    5. Context menu items
    6. Options page
    7. Bundled web pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. Concepts
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Internationalization
    5. Content Security Policy
    6. Native messaging
  6. Porting
    1. Porting a Google Chrome extension
    2. Porting a legacy Firefox extension
    3. Embedded WebExtensions
    4. Comparison with the Add-on SDK
    5. Comparison with XUL/XPCOM extensions
    6. Chrome incompatibilities
    7. Differences between desktop and Android
  7. Firefox workflow
    1. Temporary Installation in Firefox
    2. Debugging
    3. Developing for Firefox for Android
    4. Getting started with web-ext
    5. web-ext command reference
    6. Extensions and the Add-on ID
    7. Publishing your extension
  8. JavaScript APIs
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browsingData
    6. commands
    7. contextMenus
    8. contextualIdentities
    9. cookies
    10. devtools.inspectedWindow
    11. devtools.network
    12. devtools.panels
    13. downloads
    14. events
    15. extension
    16. extensionTypes
    17. history
    18. i18n
    19. identity
    20. idle
    21. management
    22. notifications
    23. omnibox
    24. pageAction
    25. permissions
    26. privacy
    27. proxy
    28. runtime
    29. sessions
    30. sidebarAction
    31. storage
    32. tabs
    33. topSites
    34. types
    35. webNavigation
    36. webRequest
    37. windows
  9. Manifest keys
    1. applications
    2. author
    3. background
    4. browser_action
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. commands
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. homepage_url
    15. icons
    16. incognito
    17. manifest_version
    18. name
    19. omnibox
    20. optional_permissions
    21. options_ui
    22. page_action
    23. permissions
    24. protocol_handlers
    25. short_name
    26. sidebar_action
    27. version
    28. web_accessible_resources
  10. Themes
  11. Publishing add-ons
  12. Guides
    1. Signing and distribution overview
    2. Submit an add-on
    3. Creating an appealing listing
    4. Review policies
    5. Developer agreement
    6. Featured add-ons
    7. Contact addons.mozilla.org
  13. Community and support
  14. Channels
    1. Add-ons blog
    2. Add-on forums
    3. Stack Overflow
    4. Development newsgroup
    5. IRC Channel
  15. Legacy add-ons
  16. Legacy technologies
    1. Add-on SDK
    2. Legacy Firefox for Android
    3. Bootstrapped extensions
    4. Overlay extensions