Note: NPM v5 changed completely the way it builds local modules, breaking the Graylog web interface build. Please use Yarn instead of NPM v5.
yarn startto build the project for development and start the development server. You can exclude any Graylog frontend plugins from the build by running
disable_plugins=true npm startinstead
yarn start (or
disable_plugins=true yarn start) command will run an Express web server which is configured to do a full page reload in your browser every time that you save a file. This ensures that you will always use the latest version of your code.
You can start the development server in any other host and port that you like:
--host=<hostname>option to change the default host the development server uses. The default host is
--port=<port>option to change the default port number the development server uses. The default value is
8080. The server will pick a random port if the port you try to use is already in use
yarn start --host=0.0.0.0 --port=8000 will start the development server in all available network interfaces using the port 8000.
There's an online version of the frontend documentation and component gallery at:
The online version is automatically deployed and reflects the current state of the
master branch in this repository.
You may also run the documentation locally to contribute to it or see a different version than the current master:
yarn run docs:server
We mainly develop using IntelliJ or WebStorm. If you also decide to use them to work in Graylog, enable
JSX harmony before, and it is available in one or the other form since IntelliJ 14 and WebStorm 9.
Update a single dependency
yarn upgrade <package>@<version>
Update many dependencies
yarn upgrade <package1> <package2>...
yarn upgrade --pattern <pattern>
yarn upgradeif you really want to upgrade all packages