Skip to content
This repository has been archived by the owner on Aug 26, 2021. It is now read-only.

Commit

Permalink
2.0.0 rc2
Browse files Browse the repository at this point in the history
  • Loading branch information
sochix committed Apr 18, 2018
1 parent fdfcc9c commit 5ffe20b
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 124 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
Change log
==========

2.0.0rc (2018-04-18)
-------------------

Ambar 2.0.0rc is out!

### What's new:

- Ambar is fully open-source now under MIT license
- Only local fs crawler is supported now
- Ambar management script was removed and replaced by a single docker-compose file
- Users and authentication were removed

1.3.0 (2017-11-17)
-------------------

Expand Down
2 changes: 1 addition & 1 deletion Install.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ To keep these setting after reboot you should add them into your `/etc/sysctl.co

# Create docker-compose file

Download latest [docker-compose file](...) from our GitHub.
Download latest [docker-compose file](https://github.com/RD17/ambar/blob/master/docker-compose.yml) from our GitHub.

Then modify it:

Expand Down
45 changes: 4 additions & 41 deletions License.txt
Original file line number Diff line number Diff line change
@@ -1,44 +1,7 @@
Fair Source License, version 0.9
Copyright (C) 2018 Ambar LLC

Copyright (C) 2017 Ambar LLC
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Licensor: Ambar LLC
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

Software: Ambar

Use Limitation: 1 user

License Grant. Licensor hereby grants to each recipient of the
Software ("you") a non-exclusive, non-transferable, royalty-free and
fully-paid-up license, under all of the Licensor’s copyright and
patent rights, to use, copy, distribute, prepare derivative works of,
publicly perform and display the Software, subject to the Use
Limitation and the conditions set forth below.

Use Limitation. The license granted above allows use by up to the
number of users per entity set forth above (the "Use Limitation"). For
determining the number of users, "you" includes all affiliates,
meaning legal entities controlling, controlled by, or under common
control with you. If you exceed the Use Limitation, your use is
subject to payment of Licensor’s then-current list price for licenses.

Conditions. Redistribution in source code or other forms must include
a copy of this license document to be provided in a reasonable
manner. Any redistribution of the Software is only allowed subject to
this license.

Trademarks. This license does not grant you any right in the
trademarks, service marks, brand names or logos of Licensor.

DISCLAIMER. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OR
CONDITION, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. LICENSORS HEREBY DISCLAIM ALL LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE.

Termination. If you violate the terms of this license, your rights
will terminate automatically and will not be reinstated without the
prior written consent of Licensor. Any such termination will not
affect the right of others who may have received copies of the
Software from you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 2 additions & 2 deletions LocalCrawler/src/config.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
const defaultConfig = {
"port": 8082,
"bodyLimit": "10mb",
"crawlPath": "C:\\TEST",
"crawlPath": "C:\\Dropbox\\Development\\Git\\Ambar\\LocalCrawler\\node_modules",
"apiUrl": "http://ambar:8081",
"allowedFilesRegex": '(\\.doc[a-z]*$)|(\\.xls[a-z]*$)|(\\.txt$)|(\\.pst$)|(\\.csv$)|(\\.htm[a-z]*$)|(\\.ppt[a-z]*$)|(\\.pdf$)|(\\.msg$)|(\\.zip$)|(\\.eml$)|(\\.rtf$)|(\\.md$)|(\\.png$)|(\\.bmp$)|(\\.tif[f]*$)|(\\.jp[e]*g$)',
"name": "local_crawler",
"name": "nodemodules-crawler",
"maxFileSize": "30mb"
}

Expand Down
95 changes: 33 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
[![Version](https://img.shields.io/badge/Version-v1.3.0-brightgreen.svg)](https://ambar.cloud)
[![License](https://img.shields.io/badge/License-Fair%20Source%20v0.9-blue.svg)](https://github.com/RD17/ambar/blob/master/License.txt)
[![Version](https://img.shields.io/badge/Version-v2.0.0rc-brightgreen.svg)](https://ambar.cloud)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/RD17/ambar/blob/master/License.txt)
[![Blog](https://img.shields.io/badge/Ambar%20Blog-%20Latest%20news%20and%20tutorials%20-brightgreen.svg)](https://blog.ambar.cloud)

:mag: Ambar: Document Search System
:mag: Ambar: Document Search Engine
================================

![Ambar Search](https://ambar.cloud/images/search.gif)

Ambar is an open-source document search and management system with automated crawling, OCR, tagging and instant full-text search.
Ambar is an open-source document search engine with automated crawling, OCR, tagging and instant full-text search.

Ambar defines the new way to manage your documents out of the box:

- Ingest documents from any source
- Find documents and images instantly with Google-like search
- Manage your documents with tags, hide irrelevant search results
- Auto tagging & named entitites recognition
Ambar defines the new way to implement a full-text document search into yor workflow:
- Easily deploy Ambar with a single `docker-compose` file
- Perform a Google-like search through your documents and images contents
- Ambar supports all popular document formats, performs OCR if needed
- Tag your documents
- Use a simple REST Api to integrate Ambar into your workflow

## Features

Expand All @@ -33,16 +33,14 @@ Ambar defines the new way to manage your documents out of the box:

### Crawling

* [SMB Crawling](https://blog.ambar.cloud/advanced-ambar-usage-crawling-your-own-shared-folders/)
* [FTP/FTPS Crawling](https://blog.ambar.cloud/crawling-and-searching-ftp-folder-with-ambar/)
* [Mail Crawling](https://blog.ambar.cloud/crawling-and-searching-email-inbox-with-ambar/)
* [Dropbox Crawling](https://blog.ambar.cloud/how-to-search-through-your-dropbox-files-content/)
* Scheduled Crawling (Cron schedule syntax)
Ambar 2.0 only supports local fs crawling, if you need to crawl an SMB share of an FTP location - just mount it using standard linux tools.
Crawling is automatic, no schedule is needed since the crawler monitors fs events and automatically processes new files.

### Content Extraction

* Extract content from large files (>30M)
* Ambar supports large files (>30MB)
* ZIP archives
* Mail archives (PST)
* MS Office documents (Word, Excel, Powerpoint, Visio, Publisher)
* OCR over images
* Email messages with attachments
Expand All @@ -53,82 +51,55 @@ Ambar defines the new way to manage your documents out of the box:
* HTML / XHTML
* Multithread processing (Only EE)

### General

* Files Tagging (Auto tagging as well)
* Named Entitites
* Hiding Irrelevant Search Results
* Files Preview
* Web UI
* [REST API](https://github.com/RD17/ambar/blob/master/API_DOC.md)
* Multiple user accounts (Only EE)

## Editions
There are two editions available: Community and Enterprise. Enterprise Edition is a full featured document search and management system that can handle terabytes of data.

Community Edition is a scaled down, single user version of Enterprise Edition with limited number of pipelines and crawlers, though preserving the full functionality. You are welcome to use Ambar Community Edition for both personal and commercial purposes, at no cost.

## Installation

Installation is straightforward. Turn on your Linux machine and follow our [step-by-step installation guide](https://blog.ambar.cloud/ambar-installation-step-by-step-guide-2/).
Just follow the [instruction instruction](https://github.com/RD17/ambar/blob/master/install.md)

*Docker images can be found on [Docker Hub](https://hub.docker.com/u/ambar/)*

## How it Works
## Support

Ambar is fully open-source and free to use, however you can get a dedicated support from our team for a fee:

* [Under the Hood](https://blog.ambar.cloud/ambar-under-the-hood/)
* [REST API Documentation](https://github.com/RD17/ambar/blob/master/API_DOC.md)
* [Management Script](https://blog.ambar.cloud/ambar-management-script-full-description/)
* The Source Code is freely available under [Fair Source License 1](https://github.com/RD17/ambar/blob/master/License.txt). ([Frontend](https://github.com/RD17/ambar-frontend), [Crawler](https://github.com/RD17/ambar-crawler), [ElasticSearch](https://github.com/RD17/ambar-es), [Rabbit](https://github.com/RD17/ambar-rabbit), [Mongo](https://github.com/RD17/ambar-mongodb), [Installer](https://github.com/RD17/ambar-install))
- Install & Configure Ambar on your machine - 999$
- Mount external data source - 99$
- Add automatic tagging rule - 299$
- Add password protection to Ambar UI - 299$
- Add custom file extractor - 599$
- Dedicated support - 199$/hour
- Custom features development - 299$/hour

## FAQ
### Is it open-source?
Yes, almost every Ambar's module is published on GitHub under [Fair Source License 1](https://github.com/RD17/ambar/blob/master/License.txt)
Yes, it's fully open-source now.

### Is it free?
Yes, Community Edition is forever free. We will NOT charge a penny from you to use it.
Yes, it is forever free.

### Does it perform OCR?
Yes, it performs OCR on images (jpg, tiff, bmp, etc) and PDF's. OCR is perfomed by well-known open-source library Tesseract. We tuned it to achieve best perfomance and quality on scanned documents. You can easily find all files on which OCR was perfomed with `tags:ocr` query

### Which languages are supported for OCR?
Supported languages: Eng, Rus, Ita, Deu, Fra, Spa, Pl, Nld.
If you miss your language, please create a new issue and we'll add it ASAP.
If you miss your language please contact us on [email protected].

### Does it support tagging?
Yes!

### What about searching in PDF?
Yes, it can search through any PDF, even badly encoded or with scans inside. We did our best to make search over any kind of pdf document smooth.

### I miss XXX language analyzer. Can you add it?
Yes, please create an issue on GitHub.

### Are you going to add UI localizations?
As for now there are two options: Russian and English, change `uiLang` in your `config.json`. If you want to add your own localization, please contact us on [email protected].

### What is the maximum file size it can handle?
It's limited by amount of RAM on your machine, typically 500MB. It's an awesome result, as typical document managment systems offer 30MB maximum file size to be processed.

### What is the difference between Ambar CE and Ambar EE?
Basically Ambar CE is a downscaled Ambar EE. Check comparison on our [landing page](https://ambar.cloud).

### Can anyone else see my documents?
Nope, check our Privacy Policy.
It's limited by amount of RAM on your machine, typically it's 500MB. It's an awesome result, as typical document managment systems offer 30MB maximum file size to be processed.

### I have a problem what should I do?
Submit an issue
Request a dedicated support session by mailing us on [email protected]

## Change Log
[Change Log](https://github.com/RD17/ambar/blob/master/CHANGELOG.md)

## Contributors
- [hartmch](https://github.com/hartmch)
- [bdevelops](https://github.com/bdevelops)
[Change Log](https://github.com/RD17/ambar/blob/master/changelog.md)

## Privacy Policy
[Privacy Policy](https://github.com/RD17/ambar/blob/master/Privacy%20Policy.md)
[Privacy Policy](https://github.com/RD17/ambar/blob/master/privacy-policy.md)

## License
[Fair Source 1 License v0.9](https://github.com/RD17/ambar/blob/master/License.txt)

[MIT License](https://github.com/RD17/ambar/blob/master/license.txt)
17 changes: 0 additions & 17 deletions SupportAndPricing.md

This file was deleted.

2 changes: 1 addition & 1 deletion Privacy Policy.md → privacy-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Unless you notify Ambar LLC otherwise in writing, You hereby grant to Ambar LLC

## Changes

If we are going to change our Privacy Policy we will inform our users about this fact, by sending an appropriate email to the email address of the owner’s account registered in our service.
If we are going to change our Privacy Policy we will inform our users about this fact, by sending an appropriate email to the email address of the owner’s account registered in our service.

0 comments on commit 5ffe20b

Please sign in to comment.