silk-fusion

v4.0.1

Silk is an open source (Apache Licensed), browser based analytics and search dashboard for Solr. Silk is a snap to setup and start using. Silk strives to be easy to get started with, while also being flexible and powerful. For more information about how to use this package see README

Latest version published 9 years ago

License: Apache 2.0

NPM

GitHub

Package Health Score

51 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
4.0.1	\|	03/2016	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache 2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (11)

GitHub Stars: 69
Forks: 34
Contributors: 40

Direct Usage Popularity

The npm package silk-fusion receives a total of 11 downloads a week. As such, we scored silk-fusion popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package silk-fusion, we found that it has been starred 69 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 40
Funding: No

With more than 10 contributors for the silk-fusion repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like silk-fusion is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 8
Open PR: 2
Last Release: 9 years ago
Last Commit: 9 years ago

Further analysis of the maintenance status of silk-fusion based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for silk-fusion is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 9 years
Dependencies: 0 Direct
Versions: 3
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

silk-fusion has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Silk 4.0.0

Silk is a fork of Kibana, an open source (Apache Licensed), browser based analytics and search dashboard for Solr. Silk is a snap to setup and start using. Silk strives to be easy to get started with, while also being flexible and powerful.

The goal is to create a rich and flexible UI, enabling users to rapidly develop end-to-end applications that leverage the power of Apache Solr. Data can be ingested into Solr through a variety of ways, including Flume, Logstash and other connectors.

Requirements

Solr 5.0 or later.
Node.js 0.12 or later (older versions might work too, but not tested).
A modern web browser. The latest version of Chrome and Firefox have been tested to work.

Running from development tree

Setting up build dependency...

npm install
bower install

Building front-end code...

grunt build

Running server...

npm run server

Installation

Download and install Node.js.
Download and install Solr.
Download Silk.
Start Solr in SolrCloud mode by running $SOLR_HOME/bin/solr start -c on Unix, or $SOLR_HOME\bin\solr.cmd start -c on Windows.
Create a Solr collection named, silkconfig, which will store Silk's settings and saved objects like saved searches and dashboards:

Run this command to create silkconfig collection:

$SOLR_HOME/bin/solr create -c silkconfig -d $SILK_HOME/silkconfig/

Verify that silkconfig collection is created in the Solr Admin page.

NOTES: Solr comes with some example data that you can use to get started with Silk. For example, check out the directory $SOLR_HOME/example/films/ (or the online version Films example).

Change directory to $SILK_HOME and run command npm run start to start Silk.

NOTES: The first run will take a while, depending on your Internet connection, because Silk needs to download all the necessary Node modules. When it is ready, you should see a message saying Listening on 0.0.0.0:5601.
Open your browser and goto https://localhost:5601

Quick Start

You're up and running! Fantastic! Silk is now running on port 5601, so point your browser at https://YOURDOMAIN.com:5601.

The first screen you arrive at will ask you to configure a collection. A collection describes to Silk how to access your data in Solr. We make the guess that you're working with log data. By default, we fill in logs as your collection, thus the only thing you need to do is select which field contains the timestamp you'd like to use. Silk reads your Solr schema to find your time fields - select one from the list and hit Create.

NOTES: If you indexed Solr's Films example data, then you should be able to create films collection in Silk now. The time field name is initial_release_date. However, if you do not want to specify the time field, then uncheck the checkbox for Collection contains time-based events. This will allow you to create the collection without the time field (as a filter query), and consequently, the dashboard will perform searches on all documents in the collection.

Congratulations, you have a collection! You should now be looking at a paginated list of the fields in your index or indices, as well as some informative data about them. Silk has automatically set this new collection as your default collection for searching.

Did you know: Both indices and indexes are acceptable plural forms of the word index. Knowledge is power.

Now that you've configured a collection, you're ready to hop over to the Discover screen and try out a few searches. Click on Discover in the navigation bar at the top of the screen.

Documentation

Visit Lucidworks.com for the full Silk documentation.

FAQ

Q: Can I use Solr 4.x with Silk?

A: Yes, you can BUT some functionalities will not work. For example, all of the aggregate functions (sum, avg, min, and max) in Visualizations will not work with Solr 4.x.

Resources

Lucidworks Silk: https://www.lucidworks.com/lucidworks-silk/
Webinar on LucidWorks SILK: https://programs.lucidworks.com/SiLK-introduction_Register.html.
LogStash: https://logstash.net/
SILK Use Cases: https://github.com/LucidWorks/silkusecases. Provides example configuration files, schemas and dashboards required to build applications that use Solr and Banana.

Support

If you have any questions or comments, please visit our Google Group Forum.

Trademarks

Kibana is a trademark of Elasticsearch BV
Logstash is a trademark of Elasticsearch BV

FAQs

What is silk-fusion?

Silk is an open source (Apache Licensed), browser based analytics and search dashboard for Solr. Silk is a snap to setu... Visit Snyk Advisor to see a full health score report for silk-fusion, including popularity, security, maintenance & community analysis.

Is silk-fusion popular?

The npm package silk-fusion receives a total of 11 weekly downloads. As such, silk-fusion popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is silk-fusion well maintained?

We found indications that silk-fusion is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is silk-fusion safe to use?

The npm package silk-fusion was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 06:20 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP