Skip to content

The Notifications plugin provides a central location for all of your notifications from OpenSearch plugins. You can use either OpenSearch Dashboards or the REST API to configure notifications. Dashboards offers a more organized way of selecting a channel type and selecting which OpenSearch plugin sources you want to use.

License

Notifications You must be signed in to change notification settings

yuye-aws/dashboards-notifications

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenSearch Dashboards Notifications

Dashboards Notifications plugin provides an interface that helps users to manage and view notifications using the OpenSearch Notifications plugin.

Documentation

Please see our technical documentation to learn more about its features.

Setup

  1. Download OpenSearch for the version that matches the OpenSearch Dashboards version specified in package.json.

  2. Download the OpenSearch Dashboards source code for the version specified in package.json you want to set up.

  3. Change your node version to the version specified in .node-version inside the OpenSearch Dashboards root directory.

  4. Create a plugins directory inside the OpenSearch Dashboards source code directory, if plugins directory doesn't exist.

  5. Check out this package from version control into the plugins directory.

    git clone [email protected]:opensearch-project/dashboards-notifications.git plugins --no-checkout
    cd plugins
    echo 'dashboards-notifications/*' >> .git/info/sparse-checkout
    git config core.sparseCheckout true
    git checkout dev
    
  6. Run yarn osd bootstrap inside OpenSearch-Dashboards/plugins/dashboards-notifications.

Ultimately, your directory structure should look like this:

.
├── OpenSearch Dashboards
│ └── plugins
│   └── dashboards-notifications

Build

To build the plugin's distributable zip simply run yarn build.

Example output: ./build/notificationsDashboards*.zip

Run

  • yarn start

    Starts OpenSearch Dashboards and includes this plugin. OpenSearch Dashboards will be available on localhost:5601.

  • yarn test

    Runs the plugin unit tests.

Contributing to OpenSearch Dashboards Notifications

We welcome you to get involved in development, documentation, testing the dashboards-notifications plugin. See our CONTRIBUTING.md and join in.

Bugs, Enhancements or Questions

Please file an issue to report any bugs you may find, enhancements you may need or questions you may have here.

License

This code is licensed under the Apache 2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.

About

The Notifications plugin provides a central location for all of your notifications from OpenSearch plugins. You can use either OpenSearch Dashboards or the REST API to configure notifications. Dashboards offers a more organized way of selecting a channel type and selecting which OpenSearch plugin sources you want to use.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.0%
  • JavaScript 7.0%