Package your add-in using Napa or Visual Studio to prepare for publishing

Office Add-ins

Package your Office Add-in to prepare it for publishing.

Last modified: August 17, 2015

Applies to: Access apps for SharePoint | apps for Office | Excel | Office Add-ins | Outlook | PowerPoint | Project | Word

Learn more about supported hosts and other requirements.

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

In this article
Prerequisites
Package an Office Add-in that you create by using the Napa add-in
Deploy your web project and package your add-in by using Visual Studio 2013
Deploy your web project and package your add-in by using Visual Studio 2012
Additional resources

The package contains an XML file that you’ll use to publish the add-in. You’ll have to publish the web application files of your project separately.

To package an Office Add-in that you create by using Napa Office 365 Development Tools, you'll need:

To package an Office Add-in that you create by using Visual Studio, you'll need:

  1. In Napa, on the side of the page, choose the Publish button (Publish button).

  2. In the Publish settings dialog box, choose Next.

  3. Provide the URL of the website that will host the content files of your add-in (for example, the default html and JavaScript files of your project), and then choose Publish.

  4. In the Publish successful dialog box, choose the Publish location link.

    A document library appears that contains the XML manifest file of your add-in, and the web content files.

Next, manually copy the web content files of (style sheets, JavaScript files, and HTML files) to the web server that hosts the website that you provided in the Publish settings dialog box.

To publish your add-in, upload your XML manifest file to the Office Store, SharePoint catalog, file share, or Exchange server. For more information, see Publish your Office Add-in and Upload Office and SharePoint Add-ins and Office 365 web apps to the Office Store.

To deploy your web project

  1. In Solution Explorer, open the shortcut menu for the add-in project, and then choose Publish.

    The Publish your add-in page appears.

  2. In the Current profile drop-down list, select a profile or choose <New …> to create a new profile.

    Note Note

    A publish profile specifies the server you are deploying to, the credentials needed to log on to the server, the databases to deploy, and other deployment options.

    If you choose <New …>, the Create publishing profile wizard appears. You can use this wizard to import a publishing profile from a web site hosting provider such as Microsoft Azure or create a new profile and add your server, credentials, and other settings in the next procedure.

    For more information about importing publishing profiles or creating new publishing profiles, see Creating a Publish Profile.

  3. In the Publish your add-in page, choose the Deploy your web project link.

    The Publish Web dialog box appears. For more information about using this wizard, see How to: Deploy a Web Project using On-Click Publishing in Visual Studio.

To package your add-in

  1. In the Publish your add-in page, choose the Package the add-in link.

    The Publish Office and SharePoint Add-ins wizard appears.

  2. In the Where is your website hosted? dropdown list, select or enter the URL of the website that will host the content files of your add-in, and then choose Finish.

    You have to specify an address that begins with the "https" prefix. In general, using an https endpoint for your website is the best approach, but if you don’t plan to publish your add-in to the Office Store, you don’t have to use one. However, to complete this wizard, you must specify an address that begins with the https prefix. After the package is created, you can open the manifest in Notepad and replace the "https" prefix of your website with an "http" prefix. For more information, see Why do my add-ins have to be SSL-secured?.

    Note Note

    Azure websites automatically provide an HTTPS endpoint.

    Visual Studio generates the files that you need to publish your add-in and then opens the publish output folder.

If you plan to submit your add-in to the Office Store, you can choose the Perform a validation check link to identify issues that will prevent your add-in from being accepted. You should address all issues before you submit your add-in to the store.

When you’re ready to publish your add-in, upload your XML manifest file to the Office Store, SharePoint catalog, file share, or Exchange server. You can find the XML manifest in OfficeAppManifests folder in the app.publish folder (for example, %UserProfile%\Documents\Visual Studio 2012\Projects\MyApp\bin\Debug\app.publish\OfficeAppManifests). For more information, see Publish your Office Add-in and Upload Office and SharePoint Add-ins and Office 365 web apps to the Office Store.

  1. In Solution Explorer, open the shortcut menu for the add-in project, and then choose Publish.

    The Publish Office Add-ins wizard appears.

  2. In the Which Publish Profile do you want to publish? dropdown list, enter the name of a new profile, and then choose the Next button.

    A publish profile specifies the server you are deploying to, the credentials needed to log on to the server, the databases to deploy, and other deployment options.

  3. In the Where is your website hosted? dropdown list, select or enter the URL of the website that will host the content files of your add-in (for example, the default html and JavaScript files of your project), and then choose the Publish button.

    You have to specify an address that begins with the "https" prefix. For more information, see Why do my add-ins have to be SSL-secured?.

    Note Note

    Azure websites automatically provide an https end-point.

    In general, using an https endpoint for your website is the best approach, but if you don’t plan to publish your add-in to the Office Store, you don’t have to use one. However, to complete this wizard, you must specify an address that begins with the https prefix. After the package is created, you can open the manifest in Notepad and replace the "https" prefix of your website with an "http" prefix.

  4. Verify the information that appears in the summary page, and then choose the Finish button.

    Visual Studio generates all of the files that you need to publish your add-in and then opens the publish output folder. If you accidentally close that folder, you can find your publishing files in the app.Publish folder of your project output folder (For example, %UserProfile%\Documents\Visual Studio 2012\Projects\MyApp\bin\Debug\app.publish).

When you complete the wizard, Visual Studio creates a deployment package for your web application project. The deployment package of the web application project appears in a ZIP file that is located in the app.publish folder along with several other supportive files.

For more information about how to install the deployment package on the destination web server, see the Installing the Package section in the topic How to: Create a Web Deployment Package in Visual Studio.

To publish your add-in, upload the XML manifest file of your add-in to the Office Store, Office Add-ins catalog, SharePoint, file share, or Exchange catalog. You can find the XML manifest of your add-in in OfficeAppManifests folder in the app.publish folder (For example, %UserProfile%\Documents\Visual Studio 2012\Projects\MyApp\bin\Debug\app.publish\OfficeAppManifests). For more information, see Publish your Office Add-in and Upload Office and SharePoint Add-ins and Office 365 web apps to the Office Store.

Show:
© 2015 Microsoft