@sym20/extension-webpack-plugin v0.1.2
@sym20/extension-webpack-plugin
This extension is used to pack a Symphony 2.0 extension into a .tgz
file that can be deployed into a Symphony 2.0 Client instance.
This package is part of the Symphony Client 2.0 Extension API. Please visit http://sym20.oss.symphony.com for more information.
(c) 2020 Symphony Communication Services, LLC. All rights reserved.
Install
Install with npm:
npm install @sym20/extension-webpack-plugin
Install with yarn:
yarn add @sym20/extension-webpack-plugin
Usage
In webpack.config.js
:
const Sym20WebpackPlugin = require('@sym20/extension-webpack-plugin');
module.exports = {
...
plugins: [
new Sym20WebpackPlugin({
name: 'Hello World Symphony extension',
cwd: './dist',
files: [
'./extension.js'
]
})
],
...
};
Deployment
An extension can be deployed into an existing Symphony Client 2.0 instance.
The Symphony Client is deployed in an AWS S3 bucket, and each extension is also installed in an S3 bucket. To deploy an extension you need to have access to the S3 bucket.
To deploy an extension, unpack the extension .tgz
file and run the install-extension.sh
file
that it contains.
This example deploys a plugin in the S3 bucket named front-end-dev
:
$ tar zxf hello-world-v1.0.0.tgz
$ ./install-extension.sh --bucket front-end-dev
Run ./install-extension.sh --help
for a list of available options.
API Reference
API documentation for this package can be found here
Full documentation of the Symphony 2.0 Client Extension API can be found here
Disclaimer
The documentation, APIs and behavior of Symphony 2.0 Extension API is currently under development and might be subject to changes. No backwards compatibility is in any way guaranteed.