SharePoint Framework Docker images

Docker images for running SharePoint Framework.

Usage

• in Docker Settings > Shared Drives verify that the drive where you create your projects is shared
• Create a folder for your SharePoint Framework project
• In the command line (on macOS):

cd [your project]
docker run -it --rm --name ${PWD##*/} -v $PWD:/usr/app/spfx -p 4321:4321 -p 35729:35729 m365pnp/spfx

• In PowerShell on Windows:

cd [your project]
docker run -it --rm --name spfx-helloworld -v ${PWD}:/usr/app/spfx -p 4321:4321 -p 35729:35729 m365pnp/spfx

• In other shells on Windows

cd [your project]
docker run -it --rm --name spfx-helloworld -v %cd%:/usr/app/spfx -p 4321:4321 -p 35729:35729 m365pnp/spfx

After the container started you can work with it the same way you would work with SharePoint Framework installed on your host. To create a new SharePoint Framework project in the container command line execute:

yo @microsoft/sharepoint

All files scaffolded by the generator will be stored in your project directory on your host from where you can commit them to source control.

To close the container in the container command line run:

exit

You can also use this image for Visual Studio development containers

Available tags

• latest: contains the SharePoint Framework Yeoman generator from the 1.20.0 release
• online: contains the SharePoint Framework Yeoman generator from the 1.20.0 release
• onprem: contains the SharePoint Framework Yeoman generator from the 1.4.1 release
• 1.20.0: contains the SharePoint Framework Yeoman generator from the 1.20.0 release
• 1.19.0: contains the SharePoint Framework Yeoman generator from the 1.19.0 release
• 1.18.2: contains the SharePoint Framework Yeoman generator from the 1.18.2 release
• 1.18.1: contains the SharePoint Framework Yeoman generator from the 1.18.1 release
• 1.18.0: contains the SharePoint Framework Yeoman generator from the 1.18.0 release
• 1.17.4: contains the SharePoint Framework Yeoman generator from the 1.17.4 release
• 1.17.3: contains the SharePoint Framework Yeoman generator from the 1.17.3 release
• 1.17.2: contains the SharePoint Framework Yeoman generator from the 1.17.2 release
• 1.17.1: contains the SharePoint Framework Yeoman generator from the 1.17.1 release
• 1.17.0: contains the SharePoint Framework Yeoman generator from the 1.17.0 release
• 1.16.1: contains the SharePoint Framework Yeoman generator from the 1.16.1 release
• 1.16.0: contains the SharePoint Framework Yeoman generator from the 1.16.0 release
• 1.15.2: contains the SharePoint Framework Yeoman generator from the 1.15.2 release
• 1.15.0: contains the SharePoint Framework Yeoman generator from the 1.15.0 release
• 1.14.0: contains the SharePoint Framework Yeoman generator from the 1.14.0 release
• 1.13.1: contains the SharePoint Framework Yeoman generator from the 1.13.1 release
• 1.13.0: contains the SharePoint Framework Yeoman generator from the 1.13.0 release
• 1.12.1: contains the SharePoint Framework Yeoman generator from the 1.12.1 release
• 1.12.0: contains the SharePoint Framework Yeoman generator from the 1.12.0 release
• 1.11.0: contains the SharePoint Framework Yeoman generator from the 1.11.0 release
• 1.10.0: contains the SharePoint Framework Yeoman generator from the 1.10.0 release
• 1.9.1: contains the SharePoint Framework Yeoman generator from the 1.9.1 release
• 1.8.2: contains the SharePoint Framework Yeoman generator from the 1.8.2 release
• 1.8.1: contains the SharePoint Framework Yeoman generator from the 1.8.1 release
• 1.8.0: contains the SharePoint Framework Yeoman generator from the 1.8.0 release
• 1.7.1: contains the SharePoint Framework Yeoman generator from the 1.7.1 release
• 1.7.0: contains the SharePoint Framework Yeoman generator from the 1.7.0 release
• 1.6.0: contains the SharePoint Framework Yeoman generator from the 1.6.0 release
• 1.5.1: contains the SharePoint Framework Yeoman generator from the 1.5.1 release
• 1.5.0: contains the SharePoint Framework Yeoman generator from the 1.5.0 release
• 1.4.1: contains the SharePoint Framework Yeoman generator from the 1.4.1 release
• 1.4.0: contains the SharePoint Framework Yeoman generator from the 1.4.0 release
• 1.3.4: contains the SharePoint Framework Yeoman generator from the 1.3.4 release
• 1.3.2: contains the SharePoint Framework Yeoman generator from the 1.3.2 release
• 1.3.1: contains the SharePoint Framework Yeoman generator from the 1.3.1 release
• 1.3.0: contains the SharePoint Framework Yeoman generator from the 1.3.0 release
• 1.2.0: contains the SharePoint Framework Yeoman generator from the 1.2.0 release
• 1.1.3: contains the SharePoint Framework Yeoman generator from the 1.1.3 release
• 1.1.1: contains the SharePoint Framework Yeoman generator from the 1.1.1 release
• 1.1.0: contains the SharePoint Framework Yeoman generator from the 1.1.0 release
• 1.0.2: contains the SharePoint Framework Yeoman generator from the 1.0.2 release
• ga: contains the SharePoint Framework Yeoman generator from the GA release
• rc0: contains the SharePoint Framework Yeoman generator from the RC0 release
• drop-6: contains the SharePoint Framework Yeoman generator from the developer preview drop 6
• drop-5: contains the SharePoint Framework Yeoman generator from the developer preview drop 5
• drop-4: contains the SharePoint Framework Yeoman generator from the developer preview drop 4

Known issues

Unable to write files to disk

When running yo @microsoft/sharepoint you get an error that the container is unable to write files to the disk. In most cases this is caused by the drive not being shared in Docker. Go to Docker > Settings > Sharing to enable sharing the drive where your project is located.

Can't access workbench and bundles in SharePoint Framework >=1.14.0

When using the container with SharePoint Framework >=v1.14.0, you can't access the local workbench or can't load bundles in the hosted workbench. This is caused by the default mapping of the workbench to localhost, which isn't accessible outside of the container. To fix it, map the workbench to 0.0.0.0, by modifying the ./config/serve.json file in your SharePoint Framework project to:

{
  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
  "port": 4321,
  "ipAddress": "0.0.0.0",
  "https": true,
  "initialPage": "https://enter-your-SharePoint-site/_layouts/workbench.aspx"
}

Can't access workbench and bundles in SharePoint Framework >=1.6.0 <=1.13.1

When using the container with SharePoint Framework >=v1.6.0, you can't access the local workbench or can't load bundles in the hosted workbench. This is caused by the default mapping of the workbench to localhost, which isn't accessible outside of the container. To fix it, map the workbench to 0.0.0.0, by modifying the ./config/serve.json file in your SharePoint Framework project to:

{
  "$schema": "https://developer.microsoft.com/json-schemas/core-build/serve.schema.json",
  "port": 4321,
  "hostname": "0.0.0.0",
  "https": true,
  "initialPage": "https://enter-your-SharePoint-site/_layouts/workbench.aspx"
}

Can't access bundles in SharePoint Framework 1.13.1

Modify node_modules\@microsoft\spfx-heft-plugins\lib\plugins\webpackConfigurationPlugin\WebpackConfigurationGenerator.js:393

const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://${serveConfig.hostname || 'localhost'}:${serveConfig.port || 4321}/${distFolderName}/`;

to:

const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://localhost:${serveConfig.port || 4321}/${distFolderName}/`;

Can't access bundles in SharePoint Framework 1.12.1

Modify node_modules\@microsoft\spfx-heft-plugins\lib\plugins\webpackConfigurationPlugin\WebpackConfigurationGenerator.js:376

const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://${serveConfig.hostname || 'localhost'}:${serveConfig.port || 4321}/dist/`;

to:

const debugBaseUrl = `${serveConfig.https ? 'https' : 'http'}://localhost:${serveConfig.port || 4321}/dist/`;

Can't access workbench and bundles in SharePoint Framework >=1.6.0 <=1.11.0 on Windows

When using the container with SharePoint Framework >=v1.6.0 on Windows, you can't access the local workbench despite following the steps from the previous section. This has to do with Windows being unable to correctly access 0.0.0.0. To fix it, first, modify config\write-manifests.json to (add the debugBasePath property):

{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/write-manifests.schema.json",
  "cdnBasePath": "<!-- PATH TO CDN -->",
  "debugBasePath": "https://localhost:4321/"
}

Then, open node_modules\@microsoft\sp-build-web\lib\SPWebBuildRig.js and change lines from:

spBuildCoreTasks.writeManifests.mergeConfig({
    debugBasePath: `${serve.taskConfig.https ? 'https' : 'http'}://${serve.taskConfig.hostname}:${serve.taskConfig.port}/`
});

to (add the if statement):

if (!spBuildCoreTasks.writeManifests.taskConfig.debugBasePath) {
    spBuildCoreTasks.writeManifests.mergeConfig({
        debugBasePath: `${serve.taskConfig.https ? 'https' : 'http'}://${serve.taskConfig.hostname}:${serve.taskConfig.port}/`
    });
}

Depending on the SPFx version the lines to replace are different:

SPFx version	SPWebBuildRig.js lines to replace
1.6.0, 1.7.0 or 1.7.1	83-85
1.8.0, 1.8.1 or 1.8.2	88-90
1.9.1	92-94
1.10.0 or 1.11.0	96-98

Can't access workbench and bundles in SharePoint Framework 1.5.0

When using the container with SharePoint Framework v1.5.0, you can't access the local workbench or can't load bundles in the hosted workbench. This is caused by a change to the gulp-connect package used by the gulp serve task. To fix the issue, after scaffolding the project, in the code editor open the ./node_modules/gulp-connect/index.js file and change line 106 from:

return this.server.listen(this.port, this.host, (function(_this) {

to (remove the this.host argument):

return this.server.listen(this.port, (function(_this) {

Limitations

Windows 10 Anniversary Update and Windows Server 2016 have native support for containers. At this moment Windows supports only containers built on Windows Server Core or Nano Server and you won't be able to run this container natively on Windows. Instead you should use Docker for Windows or Docker Toolbox.