Falanteris / Forsix-Analyzer

Forsix-Analyzer

This is the dockerized version of the system. To use the pure script one, head over to the script branch.

Now let's get started. You can either:

1. Clone this directory, Build, and Run it yourself.

2. Pulling from docker registry and run it yourself.

Option 1

$ git clone https://github.com/Falanteris/forsix-analyzer.git
$ docker build -t nethive.me/forsix .
$ docker run -d --name forsix --rm -v /path/to/your/dir:/watchdir nethive.me/forsix

Option 2

$ docker login -u forsix -p analyzer nethive.me
$ docker run -d --name forsix --rm -v /path/to/your/dir:/watchdir nethive.me/forsix

You can view logs by tail-ing the logfile inside the docker container.

$ docker exec -it forsix tail -f log/entry.log

A High Level Directory Logging Tool.

This is a College Project that me and my friends made. Right now, its able to seamlessly detect file changes within a directory. Currently the project is CLI based, we might consider using Elektron Framework to connect the module to a GUI version. But, the module is more or less ready. If you wish to try, you can git clone- this project (need to get invited first though).

Technical Details

Well, to put it simply, all you need to do is.

var listener = require("./file_listener").listener

Put that code into your Node.js code, and the listener is now ready to use.

To start listening, the listener is a Class that upon construction, would require two arguments

1. Directory

this is pretty much self explanatory.

2. Logfile

this will be the module's logging file.

To invoke the listener, you can do the following:

var newListener = new listener("C:\\foo","bar.txt")

Taking the previously made, listener Class, we would now create a new listener instance. Thankfully, most of the processeses inside the module are done Asynchronously, which means multiple instances of listener should be a ok.

Now that we have the listener instance ready, we can use the listen() method that the listener instance has, and use it to listen to the specified directory. Like this:

newListener.listen()

And that's it, listener would now be running on the specified directory.

The logfile will be created on the current working directory or cwd in short, you can view the cwd of the app by using process.cwd().

Additional Tips

1. It's recommended to use Promise to wrap the listener in case something went wrong. Since the listener would run Asynchronously

2. Make sure to use setTimeout() before running another instance of listener, this is to reduce the chance of race condition problems.