Browse Source

Adding README to the bleve/http package (#1692)

Sreekanth Sivasankaran 4 months ago
parent
commit
47021eed92
2 changed files with 12 additions and 1 deletions
  1. 2 1
      SECURITY.md
  2. 10 0
      http/README.md

+ 2 - 1
SECURITY.md

@@ -6,7 +6,8 @@ We support the latest release (for example, bleve v2.3.x).
 
 ## Reporting a Vulnerability
 
-All security issues for this project should be reported by email to fts-team@couchbase.com. This mail will be delivered to the owners of this project.
+All security issues for this project should be reported by email to security@couchbase.com and fts-team@couchbase.com. 
+This mail will be delivered to the owners of this project.
 
 - To ensure your report is NOT marked as spam, please include the word "security/vulnerability" along with the project name (blevesearch/bleve) in the subject of the email.
 - Please be as descriptive as possible while explaining the issue, and a testcase highlighting the issue is always welcome.

+ 10 - 0
http/README.md

@@ -0,0 +1,10 @@
+# http support in bleve
+
+This http package is purely for the demonstration purposes and is used by sample
+applications like https://github.com/blevesearch/bleve-explorer.
+
+Please be aware that the http handler implementations neither provide exhaustive 
+user input validations nor authentication or authorization of the user access. 
+
+So, it is recommended to remain cautious against the use of the http package in 
+production use cases.