| 1 |
= Picolena |
|---|
| 2 |
|
|---|
| 3 |
* http://picolena.devjavu.com |
|---|
| 4 |
* http://svn.devjavu.com/picolena |
|---|
| 5 |
|
|---|
| 6 |
== DESCRIPTION: |
|---|
| 7 |
|
|---|
| 8 |
Picolena is a lightweight ferret-powered documents search engine written in Ruby on rails: |
|---|
| 9 |
|
|---|
| 10 |
1. Just let Ferret index any directory you want. |
|---|
| 11 |
2. Enter queries on your browser to get corresponding documents in a few milliseconds. |
|---|
| 12 |
|
|---|
| 13 |
== FEATURES: |
|---|
| 14 |
|
|---|
| 15 |
Picolena has many advantages: |
|---|
| 16 |
|
|---|
| 17 |
* it can index .pdf, .doc, .docx, .odt, .xls, .ods, .ppt, .pptx, .odp, .rtf, .html and plain text files will full text search, and offers a very easy way to add new filters to index other filetype. |
|---|
| 18 |
* it is free as in free beer and as in free speech |
|---|
| 19 |
* thanks to Ferret, it is very fast |
|---|
| 20 |
* it keeps your data private. By default, only the computer on which it is installed can get access to the search engine. Other IP addresses can then be added to a white list. |
|---|
| 21 |
* it does not phone home. This claim is somewhat easier to verify on your server, with just a few lines of codes added, than on a Don't be evil black-box server. |
|---|
| 22 |
* it can be used to index any ftp, smb, ssh, webdav or local directory. |
|---|
| 23 |
* its user interface is available in English, German, Spanish and French. |
|---|
| 24 |
|
|---|
| 25 |
== DESCRIPTION: |
|---|
| 26 |
|
|---|
| 27 |
The 'picolena' command creates a new documents search engine, indexing directories specified as parameters. |
|---|
| 28 |
A default structure will be created in 'picolena' directory. |
|---|
| 29 |
Since picolena is Rails-based, you can launch the search-engine |
|---|
| 30 |
web-server just like you would with any Rails application. |
|---|
| 31 |
|
|---|
| 32 |
== EXAMPLE: |
|---|
| 33 |
picolena ~/shared_documents /media/literature |
|---|
| 34 |
cd picolena |
|---|
| 35 |
ruby script/server |
|---|
| 36 |
|
|---|
| 37 |
This would create the picolena file structure, index every file inside ~/shared_documents and /media/literature, and launch a web-server available at http://localhost:3000 |
|---|
| 38 |
|
|---|
| 39 |
== REQUIREMENTS: |
|---|
| 40 |
|
|---|
| 41 |
* packages : antiword poppler-utils odt2txt html2text catdoc unrtf |
|---|
| 42 |
* gems : rails ferret paginator haml rubyzip rubigen |
|---|
| 43 |
|
|---|
| 44 |
== INSTALL: |
|---|
| 45 |
|
|---|
| 46 |
* sudo gem install picolena |
|---|
| 47 |
|
|---|
| 48 |
== LICENSE: |
|---|
| 49 |
|
|---|
| 50 |
Copyright (c) 2008 Eric Duminil |
|---|
| 51 |
|
|---|
| 52 |
Permission is hereby granted, free of charge, to any person obtaining |
|---|
| 53 |
a copy of this software and associated documentation files (the |
|---|
| 54 |
'Software'), to deal in the Software without restriction, including |
|---|
| 55 |
without limitation the rights to use, copy, modify, merge, publish, |
|---|
| 56 |
distribute, sublicense, and/or sell copies of the Software, and to |
|---|
| 57 |
permit persons to whom the Software is furnished to do so, subject to |
|---|
| 58 |
the following conditions: |
|---|
| 59 |
|
|---|
| 60 |
The above copyright notice and this permission notice shall be |
|---|
| 61 |
included in all copies or substantial portions of the Software. |
|---|
| 62 |
|
|---|
| 63 |
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, |
|---|
| 64 |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|---|
| 65 |
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
|---|
| 66 |
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
|---|
| 67 |
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
|---|
| 68 |
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
|---|
| 69 |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|---|
