Skip to content
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
public
views
vueapp
.eslintignore
.eslintrc.js
.jshintrc
.postcssrc.js
Makefile.in
README.md
addUser.js
config.js
db.js
decode.js
molochparser.jison
molochparser.js
multies.js
package-lock.json
package.json
pcap.js
reindex2.js
rules.yara
version.js.in
viewer.js

README.md

Moloch Viewer

Moloch viewer is a Vue.js web app.

Read the main Moloch README for more information on how to build and run the app for demo or production. These instructions are for running in development mode out of the source tree.


Development

The viewer uses a number of node.js tools for initialization and testing. You must have node.js and its package manager (npm) installed. You can get them from http://nodejs.org/.


Install Dependencies

The viewer mostly uses development dependencies that are all bundled using webpack. We get dependencies via npm, the node package manager.

In the viewer directory, execute:

npm install

You should find that you have a new folder:

  • node_modules - contains the npm packages for the dependencies

Run the Application

To run the web application, you must have an elasticsearch cluster running and already built and configured Moloch. Read the main Moloch README for more information.

The simplest way to start the web app is:

npm run start:test

For this command to work, your tests/config.test.ini must be valid.

This command starts the node server and bundles all Vue app files into viewer/vueapp/dist.

Webpack watches for changes to relevant Vue files, and re-bundles the Vue app after each save.

Now browse to the app at http://localhost:8123.

To start the web app with a test admin user, run:

npm run addtestuser
npm run start:testuser

For this to work, your tests/config.test.ini must be valid.

These first command adds an "admin" user. The second command starts the node server and bundles all Vue app files into viewer/vueapp/dist.

Webpack watches for changes to relevant Vue files, and re-bundles the Vue app after each save.

Now browse to the app at http://localhost:8123 and login using username "admin" and password "admin".

You can also start the app with an existing config file:

npm start

For this command to work, your config.ini must be valid.

This command starts the node server and bundles and minifies all Vue app files into viewer/vueapp/dist.

Now browse to the app at http://localhost:8123.


Contributing

View the contributing guide for more information.

You can’t perform that action at this time.