├── .gitignore ├── DESIGN-v1.md ├── LICENSE ├── README.md ├── REFERENCES.md ├── RESEARCH.md ├── alternatives.csv ├── data ├── elasticsearch │ └── .gitignore ├── rabbitmq │ └── .gitignore └── storage │ └── .gitignore ├── docker-compose.yml └── docs ├── examples └── k8s │ ├── elasticsearch.yaml │ ├── ingress.yaml │ ├── processor.yaml │ ├── rabbitmq.yaml │ ├── storage.yaml │ ├── tika.yaml │ └── webapp.yaml ├── logo.png └── screenshots ├── dashboard-date-filter.png ├── dashboard-text-search.png ├── dashboard.png ├── details.png └── status.png /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### JetBrains template 3 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm 4 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 5 | 6 | # User-specific stuff 7 | .idea/**/workspace.xml 8 | .idea/**/tasks.xml 9 | .idea/**/dictionaries 10 | .idea/**/shelf 11 | 12 | # Sensitive or high-churn files 13 | .idea/**/dataSources/ 14 | .idea/**/dataSources.ids 15 | .idea/**/dataSources.local.xml 16 | .idea/**/sqlDataSources.xml 17 | .idea/**/dynamic.xml 18 | .idea/**/uiDesigner.xml 19 | .idea/**/dbnavigator.xml 20 | 21 | # Gradle 22 | .idea/**/gradle.xml 23 | .idea/**/libraries 24 | 25 | # CMake 26 | cmake-build-debug/ 27 | cmake-build-release/ 28 | 29 | # Mongo Explorer plugin 30 | .idea/**/mongoSettings.xml 31 | 32 | # File-based project format 33 | *.iws 34 | 35 | # IntelliJ 36 | out/ 37 | 38 | # mpeltonen/sbt-idea plugin 39 | .idea_modules/ 40 | 41 | # JIRA plugin 42 | atlassian-ide-plugin.xml 43 | 44 | # Cursive Clojure plugin 45 | .idea/replstate.xml 46 | 47 | # Crashlytics plugin (for Android Studio and IntelliJ) 48 | com_crashlytics_export_strings.xml 49 | crashlytics.properties 50 | crashlytics-build.properties 51 | fabric.properties 52 | 53 | # Editor-based Rest Client 54 | .idea/httpRequests 55 | 56 | .idea 57 | 58 | ./data 59 | .DS_Store 60 | -------------------------------------------------------------------------------- /DESIGN-v1.md: -------------------------------------------------------------------------------- 1 | # Design Document 2 | 3 | > NOTE: Lodestone is a Work-in-Progress and is not production ready. 4 | ## Components 5 | 6 | Lodestone is made up of a handful of components, each isolated to its own Docker container. 7 | At runtime each component is started by docker-compose, and glued together into a single application via a [reverse proxy](https://github.com/AnalogJ/lodestone/issues/31). 8 | 9 | - :ballot_box_with_check: **ElasticSearch cluster** - acts as data storage for all document content. 10 | - :ballot_box_with_check: **Publisher - Filesystem Watcher** - filesystem watcher that continuously watches directories for new files to process 11 | - **Publisher - Email Watcher** - email watcher that continuously watches an inbox for new emails 12 | - :ballot_box_with_check: **Storage** - S3 compatible blob storage api that can be used to serve files (and thumbnails) via the UI 13 | - **Queue** - used to coordinate and schedule Collectors 14 | - :ballot_box_with_check: **Web** - Static frontend for user to interact with 15 | - :ballot_box_with_check: **API** - extendable API layer used by Web component. Used to control all other components 16 | - :ballot_box_with_check: **Reverse Proxy** - Front door for application 17 | 18 | ## API 19 | 20 | We have a couple of different options for our API design, `Unified`, `Direct/Component` or `Framework` API 21 | 22 | ### :ballot_box_with_check: Unified 23 | 24 | - We can create a comprehensive API that wraps all the functionality of our components (storage/collectors/elasticsearch), 25 | providing a unified API that we can then iterate on 26 | - Components with their own HTTP API's are placed under the `/api/v1/` prefix. 27 | 28 | - `/api/v1/elasticsearch` 29 | - `/api/v1/collector/email` 30 | - `/api/v1/collector/fs` 31 | - `/api/v1/collector/queue` 32 | 33 | - Other components that do not have an API (but need to be available via HTTP) can be accessed via top level paths 34 | 35 | - :ballot_box_with_check: `/web` 36 | - :ballot_box_with_check: `/storage` 37 | 38 | - Any components that do not support a path prefix will need to have a API translation endpoint. 39 | 40 | ### Direct 41 | While the Unified API looks nice, under the hood we're basically just adding an API layer that's passing requests to underlying components 42 | We could just have the webapp interact with each component directly. No API necessary. 43 | 44 | - `/elasticsearch` 45 | - `/collector/email` 46 | - `/collector/fs` 47 | - `/storage` 48 | - `/web` 49 | 50 | ### Framework 51 | We can also use a Framework API layer, something like [Kuzzle](https://kuzzle.io/products/by-features/database-and-search-api/) 52 | Kuzzle will wrap Elasticsearch, provide a user management system, a pluggable API layer and notification/event system. 53 | 54 | https://loopback.io/doc/en/community/Elasticsearch-connector.html 55 | https://github.com/nodefony/nodefony 56 | https://moleculer.services 57 | 58 | 59 | ## :ballot_box_with_check: Storage 60 | 61 | Lodestone pledges to keep your files safe and leave them untouched. However file storage needs to take into account 62 | multiple file types and sources: 63 | 64 | - `read-only` - raw documents & files 65 | - `write-once` - files added via email or manually via the Web UI 66 | - `read-write` - thumbnails (re)created via collector for display in Web UI. 67 | 68 | In addition, the files need to be accessible via the Web UI, so they need to be served via web server. 69 | 70 | This can be done a couple of different ways: 71 | 72 | 1. Nginx container serving static content 73 | 2. :ballot_box_with_check: Minio container with an S3 compatible API + content server. 74 | 75 | Minio supports [WORM (Write-Once-Read-Multiple)](https://docs.min.io/docs/minio-server-configuration-guide.html#Worm) which 76 | means that we can ensure that files written by the UI/Email are not modified. 77 | However this would require the docker filesystem mount is `read-write` not `read-only`. 78 | 79 | ## Publisher - Filesystem 80 | 81 | 1. `fscrawler` 82 | - **Pros** 83 | - implemented and working 84 | - automatically creates ES schema 85 | - automatic OCR using Tika 86 | - **Cons** 87 | - does not have a good status API 88 | - ignores files that already exist in filestore before process starts 89 | - unsure how to scale horizontally 90 | 2. - :ballot_box_with_check: custom using `Tika` 91 | - **Pros** 92 | - flexible, we can build it to our needs 93 | - Status API 94 | - Queue integration to scale FS watcher seperate from document OCR worker 95 | - file system watcher would automatically processes any documents already existing in FS when started 96 | - **Cons** 97 | - does not exist, requires development 98 | - more complex 99 | - potentially more processor intensive 100 | - requires a Queuing system 101 | - need to create an ES schema ourselves, write ES integration code ourselves. 102 | 103 | - **References** 104 | - https://docs.filerun.com/docker-tika 105 | - https://github.com/radovskyb/watcher/issues/66 106 | - https://github.com/paulmillr/chokidar 107 | 108 | Supported Formats: 109 | 110 | - "*/*.doc" 111 | - "*/*.docx" 112 | - "*/*.xls" 113 | - "*/*.xlsx" 114 | - "*/*.ppt" 115 | - "*/*.pptx" 116 | - "*/*.pages" 117 | - "*/*.numbers" 118 | - "*/*.key" 119 | - "*/*.pdf" 120 | - "*/*.rtf" 121 | - "*/*.jpg" 122 | - "*/*.jpeg" 123 | - "*/*.png" 124 | - "*/*.tiff" 125 | - "*/*.tif" 126 | 127 | Excluded Formats 128 | 129 | # mostly taken from https://github.com/github/gitignore/tree/master/Global 130 | - "*/.gitignore" 131 | - "*/.DS_Store" 132 | - "*/._*" 133 | - "*/.Spotlight-V100" 134 | - "*/.TemporaryItems" 135 | - "*/.Trashes" 136 | - "*/Thumbs.db" 137 | - "*/Thumbs.db:encryptable" 138 | - "*/$RECYCLE.BIN" 139 | - "*/*.lnk" 140 | 141 | 142 | ## :ballot_box_with_check: Web 143 | - https://github.com/elastic/search-ui 144 | - https://swiftype.com/search-ui 145 | 146 | ## Dev Components 147 | 148 | There are a handful of components that are necessary during development. 149 | 150 | - **ElasticSearch Admin** 151 | - Kibana 152 | - [ElasticSearch Head](http://mobz.github.io/elasticsearch-head/) 153 | - [DejaVu](https://github.com/appbaseio/dejavu) 154 | 155 | 156 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | lodestone_view 4 | 5 |

6 | 7 | 8 | # Lodestone - Personal Document Search & Archive 9 | 10 | [![GitHub license](https://img.shields.io/github/license/LodestoneHQ/lodestone.svg?style=flat-square)](https://github.com/LodestoneHQ/lodestone/blob/master/LICENSE) 11 | [![Docker Pulls](https://img.shields.io/docker/pulls/analogj/lodestone.svg?style=flat-square)](https://hub.docker.com/r/analogj/lodestone) 12 | [![Gitter chat](https://img.shields.io/badge/chat-on%20gitter-brightgreen?style=flat-square)](https://gitter.im/lodestone-chat/devs) 13 | 14 | > NOTE: Lodestone is a Work-in-Progress and is not production ready. 15 | 16 | Lodestone is designed to be the modern and digital equivalent of a home filing cabinet. 17 | If you've gone searching for something similar in the past, you might be familiar with terms like Electronic Document 18 | Management System (EDMS), Document Management System (DMS) or Personal Archival. 19 | 20 | Lodestone is designed around a handful of core features: 21 | 22 | - **Full text document search** - It doesn't matter what format you're document is in, we should be able to parse it (using OCR) and let you search for the text. 23 | - **Rich tagging** - Unlike a physical file cabinet where a document can only exist in one place, digital documents support tags, allowing you to create a flexible organizational structure that works for you. 24 | - **Automated** - Document collection & OCR processing should be automatic. Just saving a file to your network drive should be enough to start document processing. 25 | - **Non-destructive** - When Lodestone processes a document, the original file will be left untouched, exactly where you left it. 26 | - **Web Accessible** - Lodestone is designed to run on a trusted home server and be accessible 24x7. 27 | - **Filesystem/Cloud Sync** - Optionally synchronize your tagged documents via a cloud storage provider of your choice (Dropbox, GDrive, etc) or access via a FUSE filesystem mount. 28 | 29 | # Screenshot 30 | 31 | ![Dashboard](docs/screenshots/dashboard.png) 32 | 33 | More screenshots available in the [docs/screenshots](docs/screenshots) directory. 34 | 35 | # Installation 36 | 37 | Lodestone is made up of a handful of open-source components, and as such its easiest to deploy using Docker/Docker Compose 38 | 39 | ```bash 40 | docker-compose up 41 | 42 | # then open the following url in your browser 43 | 44 | http://localhost/ 45 | ``` 46 | 47 | Place your documents in the `/data/storage/documents` directory, and the Filesystem Collector should automatically start processing them. 48 | 49 | If you would like some test documents to play with safely, you can take a look at the [LodestoneHQ/lodestone-test-docs](https://github.com/LodestoneHQ/lodestone-test-docs) 50 | repository. 51 | 52 | # Configuration 53 | 54 | Lodestone follows a [Convention over Configuration](https://en.wikipedia.org/wiki/Convention_over_configuration) design, which means that it works out of the box with sane defaults, but you can customize them to match your needs. 55 | 56 | Most of the configuration files are stored in the `webapp` image (source code [here](https://github.com/LodestoneHQ/lodestone-ui)), and requested by various components when they start up. 57 | 58 | - **filetypes.json** (backend/data/filetypes.json) contains lists of `includes` and `excludes` that are used by the `processor` container to decide which files to process and load into the database. 59 | 60 | - **tags.json** (backend/data/tags.json) contains a nested structure of labels that can be used to group tags and seach for your documents in the Lodestone web UI. 61 | 62 | - **mapping.json** (backend/data/mappings.json) is used to ensure that the `elasticsearch` container has a consistent data storage structue. 63 | 64 | To overide these files, just setup a Docker volume binding to the specified file in the `/lodestone/data/` directory in the `webapp` container. 65 | 66 | 67 | 68 | # Considerations 69 | 70 | Lodestone is a very opinionated solution for personal document management. As such, there's a couple things you should know before even considering it. 71 | 72 | - Currently there's no user management. Lodestone is designed to run at home, on your trusted network. This may be reconsidered at a future date. 73 | 74 | - Limited support for file types 75 | 76 | - `doc`,`docx`,`xls`,`xlsx`, `ppt`, `pptx` - Microsoft Office Documents 77 | 78 | - `pages`, `numbers`, `key` - Apple iWork Documents 79 | 80 | - `pdf` 81 | 82 | - `rtf` 83 | 84 | - `jpg`, `jpeg`, `png`, `tiff`, `tif` 85 | 86 | If you think there are additional document types that may be useful to support, please open an issue. 87 | 88 | # What about.. 89 | 90 | As mentioned above, Lodestone isn't some magical new technology. EDMS and DMS systems have been around for a long time, 91 | but unfortunately they all seem to miss one or more features that I think are required for a modern filing cabinet. 92 | 93 | Here's some of my research, but you should take a look at them yourselves. 94 | 95 | | Name | Docker/Linux | Web UI | Modern UI | Tagging | Non-destructive | OCR | Watch Folder | Email Import | 96 | | --------------------------------------------------------------- |:------------------:|:------------------:|:------------------------:|:------------------:|:---------------:|:------------------:|:------------------:|:------------------:| 97 | | [MayanEDMS](https://www.mayan-edms.com/) | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | 98 | | [Paperless](https://github.com/the-paperless-project/paperless) | :white_check_mark: | :white_check_mark: | :heavy_exclamation_mark: | :white_check_mark: | :x: | :white_check_mark: | :white_check_mark: | :white_check_mark: | 99 | 100 | 101 | Place your documents in the `/data/storage/documents` directory, and the Filesystem Collector should automatically start processing them. 102 | 103 | If you would like some test documents to play with safely, you can take a look at the [LodesoneHQ/lodestone-test-docs](https://github.com/LodestoneHQ/lodestone-test-docs) 104 | repository. 105 | 106 | If the processor doesn't pick up your files, you may have to fake an update to them to change the timestamp. This is temporary and will be resolved in a future release. You can use the command below to update the timestamp and trigger the processor: 107 | 108 | `find . -exec touch {} \;` 109 | 110 | ## Components 111 | 112 | | Name | Software Version | Docker Image | 113 | | ---------------------------- |:-------------------------------:|:---------------------------------------------------------------------------------------------------------------:| 114 | | Elasticsearch | Elasticsearch v7.2.1 | [lodestonehq/lodestone-elasticsearch](https://hub.docker.com/r/lodestonehq/lodestone-elasticsearch) | 115 | | Document Processor | Go | [lodestonehq/lodestone-document-processor](https://hub.docker.com/r/lodestonehq/lodestone-document-processor) | 116 | | Thumbnail Processor | Go | [lodestonehq/lodestone-thumbnail-processor](https://hub.docker.com/r/lodestonehq/lodestone-thumbnail-processor) | 117 | | Web / Api | Angular v11.x / ExpressJS v4.16 | [lodestonehq/lodestone-ui](https://hub.docker.com/r/lodestonehq/lodestone-ui) | 118 | | Storage | minio 2019 (S3 compatible) | [analogj/lodestone:storage](https://hub.docker.com/r/analogj/analogj/lodestone:storage) | 119 | | Queue | RabbitMQ | [lodestonehq/lodestone-rabbitmq](https://hub.docker.com/r/lodestonehq/lodestone-rabbitmq) | 120 | | OCR | Tika | [lodestonehq/lodestone-tika](https://hub.docker.com/r/lodestonehq/lodestone-tika) | 121 | 122 | # Future Development 123 | 124 | Please see our Issues system for a list of items that have been reported. All issues for the project are contained in this repo. Issues are labeled by area affected, status, and 125 | other labels as appropriate. Below are some example of filtering issues by label: 126 | 127 | - [Issues in Progress](https://github.com/LodestoneHQ/lodestone/issues?q=is%3Aopen+is%3Aissue+label%3Astatus%2Fin-progress) 128 | - [UI Issues](https://github.com/LodestoneHQ/lodestone/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fui) 129 | - [Processor Issues](https://github.com/LodestoneHQ/lodestone/issues?q=is%3Aopen+is%3Aissue+label%3Aarea%2Fprocessor) 130 | - [Documentation Needs](https://github.com/LodestoneHQ/lodestone/issues?q=is%3Aopen+is%3Aissue+label%3Atype%2Fdocumentation) 131 | 132 | Please feel free to create an issue if you have an idea for a new feature, find a bug, or have a question. 133 | 134 | # Logo 135 | 136 | - [rock by Dobs from the Noun Project](https://thenounproject.com/term/rock/481051) 137 | -------------------------------------------------------------------------------- /REFERENCES.md: -------------------------------------------------------------------------------- 1 | 2 | # Angular Reactive Forms 3 | - https://www.positronx.io/angular-checkbox-tutorial/ 4 | - https://blog.logrocket.com/form-builders-angular-8-validate-reactive-forms/ 5 | - https://blog.grossman.io/real-world-angular-reactive-forms/ 6 | - https://alligator.io/angular/reactive-forms-valuechanges/ 7 | - https://angular.io/api/forms/FormControlName#use-with-ngmodel 8 | - https://angular.io/guide/reactive-forms#generating-form-controls-with-formbuilder 9 | - https://angular.io/guide/reactive-forms#reactive-forms-api 10 | - https://stackoverflow.com/questions/40458739/two-way-binding-in-reactive-forms 11 | - https://stackoverflow.com/questions/41549426/use-of-ngmodel-within-formgroup 12 | - https://stackoverflow.com/questions/51342775/how-can-i-bind-a-form-to-a-model-in-angular-6-using-reactive-forms 13 | - https://stackoverflow.com/questions/45815176/is-using-ngmodel-in-reactive-forms-bad-practice 14 | - https://blog.angular-university.io/introduction-to-angular-2-forms-template-driven-vs-model-driven/ 15 | - https://coryrylan.com/blog/angular-custom-form-controls-with-reactive-forms-and-ngmodel 16 | - https://medium.com/@ingobrk/synchronizing-form-controls-with-the-url-in-angular-8dae03618332 17 | - https://malcoded.com/posts/angular-fundamentals-reactive-forms/ 18 | - https://stackoverflow.com/questions/39152071/cant-bind-to-formgroup-since-it-isnt-a-known-property-of-form 19 | - https://stackoverflow.com/questions/50819700/how-should-i-handle-my-dynamic-checkbox-with-angular-6 20 | - https://coryrylan.com/blog/creating-a-dynamic-checkbox-list-in-angular 21 | - https://mdbootstrap.com/support/angular/switch-radio-button-not-working/ 22 | - https://www.concretepage.com/angular-2/angular-2-radio-button-and-checkbox-example#reactive-create 23 | - https://stackblitz.com/edit/reactive-form-checkbox-v6?file=app%2Fapp.component.ts 24 | 25 | 26 | # Tika Server 27 | 28 | ``` 29 | docker-compose exec storage bash 30 | curl -vvv -X PUT -H "Accept: text/plain" -T path/to/local/file tika:9998/tika 31 | ``` 32 | -------------------------------------------------------------------------------- /RESEARCH.md: -------------------------------------------------------------------------------- 1 | 2 | # References 3 | - https://gist.github.com/shavo007/d426d9838c4dcadfbcd384ac68b6c69d 4 | - https://towardsdatascience.com/making-the-mueller-report-searchable-with-ocr-and-elasticsearch-4e73e55de341 5 | - https://github.com/dadoonet/fscrawler 6 | - http://documentcloud.github.io/docsplit/ 7 | - https://github.com/appbaseio/dejavu 8 | - http://www.vasterad.com/themes/hireo_082019/jobs-grid-layout.html 9 | 10 | # Angular + Elasticsearch 11 | - https://grokonez.com/elasticsearch/angular-6-elasticsearch-example-simple-full-text-search 12 | - https://grokonez.com/elasticsearch/angular-6-elasticsearch-example-get-all-documents-in-index 13 | - https://grokonez.com/frontend/angular/angular-6/angular-6-elasticsearch-example-quick-start-how-to-add-elasticsearch-js 14 | - https://www.elastic.co/guide/en/elasticsearch/reference/1.4/search-facets-migrating-to-aggs.html 15 | - https://elasticsearch-cheatsheet.jolicode.com/ 16 | - https://www.baeldung.com/elasticsearch-tagging 17 | - https://medium.com/zefo-tech/elastic-search-from-beginner-to-intermediate-e4177c4c769f 18 | - https://dzone.com/articles/23-useful-elasticsearch-example-queries 19 | - https://medium.com/@Benoit_Travers/elasticsearch-how-we-paginated-over-10-000-items-11198af5018c 20 | - https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html 21 | 22 | # Angular 23 | - https://juristr.com/blog/2018/01/ng-app-runtime-config/ 24 | 25 | # Logos 26 | - https://thenounproject.com/term/rock/1092727 27 | - https://thenounproject.com/term/crystal/570596 28 | - https://thenounproject.com/term/crystal/570601 29 | - https://thenounproject.com/term/quartz-crystal/570585 30 | 31 | Rock 32 | Mineral 33 | Geode 34 | Crystal 35 | Mine 36 | Gem 37 | 38 | 39 | # Keywords 40 | - Electronic Document Management System (EDMS) 41 | - Document Management System (DMS) 42 | - Personal Archival 43 | - Enterprise Search 44 | 45 | 46 | ## Alternatives 47 | A Full list of alternative is available in [alternatives.csv](alternatives.csv) 48 | 49 | -------------------------------------------------------------------------------- /alternatives.csv: -------------------------------------------------------------------------------- 1 | Name,Website,Self-Hosted,Modern Web UI,Tagging,Non-Destructive Import,OCR,Watch Folder,Email Import,Open Source,Filesystem Export 2 | Mayan EDMS,https://www.mayan-edms.com/,Yes,Yes,Yes,No,Yes,Yes,Yes,Yes, 3 | Paperless,https://github.com/the-paperless-project/paperless,Yes,No,Yes,No,Yes,Yes,Yes,Yes, 4 | Ambar.cloud,https://ambar.cloud/,Yes,Yes,Yes,Yes,Yes,Yes,?,Yes, 5 | Elastic Search Enterprise Search,,,,,,,,,, 6 | OpenDocMan,https://www.opendocman.com/,Yes,No,No,?,No,No,?,Yes, 7 | Alfresco,https://www.alfresco.com/,Yes,Yes,Yes,?,No - needs plugin,No - needs plugin,,No, 8 | LogicalDOC,https://www.logicaldoc.com/,Yes,No,Yes,?,No - paid feature,No - paid feature,?,Yes, 9 | OpenKM,https://www.openkm.ca/en/screenshots.html,No,No,,,,,,, 10 | SeedDMS,,Yes,Yes,Yes,?,No - needs plugin,Yes,?,, 11 | Nuxeo,,Yes,Yes,Yes,?,No - needs script,Yes,?,Yes, 12 | Casebox,,Yes,No,,,Yes,,,Yes - Unmaintained, 13 | EcoDMS,,,,,,,,,, 14 | Paperport,,,,,,,,,, 15 | Teedy/sismicsdocs,,Yes,Yes,Yes,No,Yes,Yes,Yes,Yes, 16 | Perkeep,,,,,,,,,, 17 | Krystal DMS,,,,,,,,,, 18 | DevonThink Pro/Server,,Yes/No,Yes,Yes,No,Yes,Yes,?,No, 19 | Neat Desk,,,,,,,,,, 20 | EagleFiler,,,,,,,,,, 21 | Paperless 3,,,,,,,,,, 22 | DocMoto,,,,,,,,,, 23 | OpenKM,,,,,,,,,, 24 | Nuxeo,,,,,,,,,, 25 | laserfiche,,,,,,,,,, 26 | Docuware,,,,,,,,,, 27 | Opentext,,,,,,,,,, 28 | treegonizer,,,,,,,,,, 29 | Open Semantic Search Server,https://www.opensemanticsearch.org/doc/admin/install/search_server,,,,,,,,, 30 | Fileago,https://github.com/fileago/fileago,Yes,,,,,,,No, 31 | Tagspaces,https://www.tagspaces.org/,,,,,,,,, 32 | FileCenter,,,,,,,,,, 33 | Odoo,,Yes,,,,No,,,No - Paid edition has DMS features, 34 | resourcespace,,,,,,,,,, 35 | Ademero Content Central,,,,,,,,,, 36 | The Brain,,,,,,,,,, 37 | Docuware,,,,,,,,,, 38 | Dokmee,,,,,,,,,, 39 | EfileCabinet,,,,,,,,,, 40 | Freemind,,,,,,,,,, 41 | XMind,,,,,,,,,, 42 | Zoho Docs,,,,,,,,,, 43 | Sharepoint,,,,,,,,,, 44 | Datamagine,,,,,,,,,, 45 | PandaDoc,,,,,,,,,, 46 | DocStar,,,,,,,,,, 47 | Wuha,,,,,,,,,, 48 | fess,,,,,,,,,, 49 | addsearch,,,,,,,,,, 50 | ContraxSuite,,,,,,,,,, 51 | https://hesbox.com/en/overview/screenshots,,,,,,,,,, 52 | https://indicaplatform.com/content/esearch-demo,,,,,,,,,, 53 | https://docs.coveo.com/en/1997/cloud-v2-administrators/available-coveo-cloud-v2-connectors,,,,,,,,,, 54 | https://www.funnelback.com/product/enterprise-search,,,,,,,,,, 55 | https://qsensei.com,,,,,,,,,, 56 | https://developer.searchblox.com/docs/license-key,,,,,,,,,, 57 | https://www.datafari.com/en/fonctionnalities.html#crawling,,,,,,,,,, 58 | https://www.predictiveanalyticstoday.com/top-open-source-big-data-enterprise-search-software/,,,,,,,,,, 59 | https://www.softwaretestinghelp.com/best-document-management-systems/,,,,,,,,,, 60 | https://www.bitrix24.com/self-hosted/,,,,,,,,,, 61 | https://www.documize.com/,,,,,,,,,, 62 | -------------------------------------------------------------------------------- /data/elasticsearch/.gitignore: -------------------------------------------------------------------------------- 1 | nodes/* -------------------------------------------------------------------------------- /data/rabbitmq/.gitignore: -------------------------------------------------------------------------------- 1 | .* 2 | mnesia/* -------------------------------------------------------------------------------- /data/storage/.gitignore: -------------------------------------------------------------------------------- 1 | .minio.sys 2 | documents/* 3 | thumbnails/* 4 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Default Docker Compose configuration 3 | ############################################################################### 4 | # This is the default docker-compose configuration for Lodestone. 5 | # You can use it to have a working Lodestone setup out of the box 6 | # 7 | # Visit http://localhost to view the Lodestone dashboard 8 | 9 | version: '2.2' 10 | services: 11 | elasticsearch: 12 | image: lodestonehq/lodestone-elasticsearch:v0.1.0 13 | environment: 14 | #- bootstrap.memory_lock=true 15 | - "ES_JAVA_OPTS=-Xms512m -Xmx512m" 16 | ulimits: 17 | memlock: 18 | soft: -1 19 | hard: -1 20 | volumes: 21 | - ./data/elasticsearch:/usr/share/elasticsearch/data 22 | 23 | document_processor: 24 | image: lodestonehq/lodestone-document-processor:v0.1.0 25 | volumes: 26 | - ./data/storage/tmp:/tmp 27 | depends_on: 28 | elasticsearch: 29 | condition: service_healthy 30 | rabbitmq: 31 | condition: service_healthy 32 | webapp: 33 | condition: service_healthy 34 | tika: 35 | condition: service_healthy 36 | command: 37 | - /lodestone-document-processor 38 | - start 39 | - --amqp-url=amqp://lodestone:lodestone@rabbitmq:5672 40 | - --api-endpoint=http://webapp:3000 41 | - --tika-endpoint=http://tika:9998 42 | - --elasticsearch-endpoint=http://elasticsearch:9200 43 | 44 | thumbnail_processor: 45 | image: lodestonehq/lodestone-thumbnail-processor:v0.1.0 46 | depends_on: 47 | rabbitmq: 48 | condition: service_healthy 49 | webapp: 50 | condition: service_healthy 51 | command: 52 | - /usr/bin/lodestone-thumbnail-processor 53 | - start 54 | - --amqp-url=amqp://lodestone:lodestone@rabbitmq:5672 55 | - --api-endpoint=http://webapp:3000 56 | 57 | webapp: 58 | image: lodestonehq/lodestone-ui:v0.1.0 59 | depends_on: 60 | elasticsearch: 61 | condition: service_healthy 62 | storage: 63 | condition: service_healthy 64 | ports: 65 | - 80:3000 66 | environment: 67 | - LS_STORAGE_HOST=${LS_STORAGE_HOST:-storage} 68 | - LS_STORAGE_PORT=${LS_STORAGE_PORT:-9000} 69 | - LS_STORAGE_PATH=${LS_STORAGE_PATH:-/storage/} 70 | - LS_ELASTICSEARCH_HOST=${LS_ELASTICSEARCH_HOST:-elasticsearch} 71 | - LS_ELASTICSEARCH_PORT=${LS_ELASTICSEARCH_PORT:-9200} 72 | - LS_RABBITMQ_HOST=${LS_RABBITMQ_HOST:-rabbitmq} 73 | - LS_RABBITMQ_PORT=${LS_RABBITMQ_PORT:-5672} 74 | - LS_RABBITMQ_MG_HOST=${LS_RABBITMQ_MG_HOST:-rabbitmq} 75 | - LS_RABBITMQ_MG_PORT=${LS_RABBITMQ_MG_PORT:-15672} 76 | - MINIO_ACCESS_KEY=minio 77 | - MINIO_SECRET_KEY=minio123 78 | - RABBITMQ_USER=lodestone 79 | - RABBITMQ_PASS=lodestone 80 | 81 | fs_publisher: 82 | image: lodestonehq/lodestone-fs-publisher:v0.1.0 83 | depends_on: 84 | rabbitmq: 85 | condition: service_healthy 86 | command: 87 | - /lodestone-fs-publisher 88 | - start 89 | - --amqp-url=amqp://lodestone:lodestone@rabbitmq:5672 90 | - --dir=/data 91 | - --bucket=documents 92 | volumes: 93 | - ./data/storage/documents:/data 94 | 95 | # E-mail publisher is currently WIP. 96 | # email_publisher: 97 | # image: lodestonehq/lodestone-email-publisher:latest 98 | # depends_on: 99 | # rabbitmq: 100 | # condition: service_healthy 101 | # webapp: 102 | # condition: service_healthy 103 | # command: 104 | # - /lodestone-email-publisher 105 | # - start 106 | # - --amqp-url=amqp://lodestone:lodestone@rabbitmq:5672 107 | # - --api-endpoint=http://webapp:3000 108 | # - --bucket=documents 109 | # - --imap-hostname=imap.gmail.com 110 | # - --imap-username=xxxx@gmail.com 111 | # - --imap-password=xxxxxxxxxxxxxx 112 | 113 | storage: 114 | image: minio/minio:latest 115 | depends_on: 116 | rabbitmq: 117 | condition: service_healthy 118 | volumes: 119 | - ./data/storage:/data 120 | command: 121 | - minio 122 | - server 123 | - /data 124 | environment: 125 | # - MINIO_BROWSER=off 126 | - MINIO_ACCESS_KEY=minio 127 | - MINIO_SECRET_KEY=minio123 128 | - MINIO_NOTIFY_AMQP_ENABLE=on 129 | - MINIO_NOTIFY_AMQP_URL=amqp://lodestone:lodestone@rabbitmq:5672 130 | - MINIO_NOTIFY_AMQP_EXCHANGE=lodestone 131 | - MINIO_NOTIFY_AMQP_EXCHANGE_TYPE=fanout 132 | - MINIO_NOTIFY_AMQP_ROUTING_KEY=storagelogs 133 | - MINIO_NOTIFY_AMQP_MANDATORY=off 134 | - MINIO_NOTIFY_AMQP_AUTO_DELETED=off 135 | - MINIO_NOTIFY_AMQP_DELIVERY_MODE=0 136 | healthcheck: 137 | test: ["CMD", "curl", "--silent", "-f", "http://localhost:9000/minio/health/ready"] 138 | interval: 5s 139 | timeout: 25s 140 | retries: 5 141 | start_period: 2s 142 | 143 | rabbitmq: 144 | image: lodestonehq/lodestone-rabbitmq:v0.1.0 145 | environment: 146 | - RABBITMQ_DEFAULT_USER=lodestone 147 | - RABBITMQ_DEFAULT_PASS=lodestone 148 | 149 | tika: 150 | image: lodestonehq/lodestone-tika:v0.1.0 151 | 152 | -------------------------------------------------------------------------------- /docs/examples/k8s/elasticsearch.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: StatefulSet 3 | apiVersion: apps/v1 4 | metadata: 5 | name: elasticsearch 6 | namespace: lodestone 7 | labels: 8 | k8s-app: elasticsearch 9 | spec: 10 | replicas: 1 11 | serviceName: elasticsearch 12 | selector: 13 | matchLabels: 14 | k8s-app: elasticsearch 15 | volumeClaimTemplates: 16 | - metadata: 17 | name: elasticsearch 18 | spec: 19 | accessModes: 20 | - ReadWriteOnce 21 | resources: 22 | requests: 23 | storage: 5Gi 24 | template: 25 | metadata: 26 | labels: 27 | k8s-app: elasticsearch 28 | spec: 29 | securityContext: 30 | runAsUser: 0 31 | runAsGroup: 0 32 | fsGroup: 0 33 | terminationGracePeriodSeconds: 30 34 | containers: 35 | - image: analogj/lodestone:elasticsearch 36 | imagePullPolicy: Always 37 | name: elasticsearch 38 | env: 39 | - name: ES_JAVA_OPTS 40 | value: "-Xms512m -Xmx512m" 41 | volumeMounts: 42 | - mountPath: /usr/share/elasticsearch/data 43 | name: elasticsearch 44 | ports: 45 | - containerPort: 9200 46 | - containerPort: 9300 47 | securityContext: 48 | allowPrivilegeEscalation: false 49 | --- 50 | kind: Service 51 | apiVersion: v1 52 | metadata: 53 | name: elasticsearch 54 | namespace: lodestone 55 | labels: 56 | k8s-app: elasticsearch 57 | spec: 58 | selector: 59 | k8s-app: elasticsearch 60 | ports: 61 | - protocol: TCP 62 | port: 9200 63 | targetPort: 9200 64 | name: rest 65 | - protocol: TCP 66 | port: 9300 67 | targetPort: 9300 68 | name: node 69 | -------------------------------------------------------------------------------- /docs/examples/k8s/ingress.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | apiVersion: extensions/v1beta1 3 | kind: Ingress 4 | metadata: 5 | annotations: 6 | kubernetes.io/ingress.class: "haproxy" 7 | ingress.kubernetes.io/ssl-redirect: "true" 8 | ingress.kubernetes.io/config-backend: | 9 | acl is_storage path_beg /storage 10 | http-request set-path %[path,regsub(^/storage/?,/)] if is_storage 11 | name: ingress-lodestone 12 | namespace: lodestone 13 | spec: 14 | rules: 15 | - host: lodestone. 16 | http: 17 | paths: 18 | - backend: 19 | serviceName: webapp 20 | servicePort: webapp 21 | path: /web 22 | - backend: 23 | serviceName: webapp 24 | servicePort: webapp 25 | path: /api 26 | - backend: 27 | serviceName: storage 28 | servicePort: storage 29 | path: /storage 30 | tls: 31 | - hosts: 32 | - lodestone. 33 | secretName: lodestone-cert 34 | -------------------------------------------------------------------------------- /docs/examples/k8s/processor.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: Deployment 3 | apiVersion: apps/v1 4 | metadata: 5 | name: processor 6 | namespace: lodestone 7 | labels: 8 | k8s-app: processor 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | k8s-app: processor 14 | template: 15 | metadata: 16 | labels: 17 | k8s-app: processor 18 | spec: 19 | securityContext: 20 | runAsUser: 0 21 | runAsGroup: 0 22 | fsGroup: 0 23 | terminationGracePeriodSeconds: 30 24 | containers: 25 | - image: analogj/lodestone:processor 26 | imagePullPolicy: Always 27 | name: processor 28 | env: 29 | - name: MINIO_ACCESS_KEY 30 | value: "minio" 31 | - name: MINIO_SECRET_KEY 32 | value: "minio123" 33 | - name: RABBITMQ_USER 34 | value: "lodestone" 35 | - name: RABBITMQ_PASS 36 | value: "lodestone" 37 | - name: LS_ELASTICSEARCH_HOST 38 | value: "elasticsearch" 39 | - name: LS_ELASTICSEARCH_PORT 40 | value: "9200" 41 | - name: LS_RABBITMQ_HOST 42 | value: rabbitmq 43 | - name: LS_RABBITMQ_PORT 44 | value: 5672 45 | - name: LS_STORAGE_HOST 46 | value: storage 47 | - name: LS_STORAGE_PORT 48 | value: "9000" 49 | - name: LS_TIKA_HOST 50 | value: "tika" 51 | - name: LS_TIKA_PORT 52 | value: "9998" 53 | securityContext: 54 | allowPrivilegeEscalation: false 55 | -------------------------------------------------------------------------------- /docs/examples/k8s/rabbitmq.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: StatefulSet 3 | apiVersion: apps/v1 4 | metadata: 5 | name: rabbitmq 6 | namespace: lodestone 7 | labels: 8 | k8s-app: rabbitmq 9 | spec: 10 | replicas: 1 11 | serviceName: rabbitmq 12 | selector: 13 | matchLabels: 14 | k8s-app: rabbitmq 15 | template: 16 | metadata: 17 | labels: 18 | k8s-app: rabbitmq 19 | spec: 20 | securityContext: 21 | runAsUser: 1000 22 | runAsGroup: 1000 23 | fsGroup: 1000 24 | terminationGracePeriodSeconds: 30 25 | containers: 26 | - image: rabbitmq:3-management 27 | imagePullPolicy: Always 28 | name: rabbitmq 29 | env: 30 | - name: RABBITMQ_DEFAULT_USER 31 | value: "lodestone" 32 | - name: RABBITMQ_DEFAULT_PASS 33 | value: "lodestone" 34 | ports: 35 | - containerPort: 5672 36 | - containerPort: 15672 37 | securityContext: 38 | allowPrivilegeEscalation: false 39 | --- 40 | kind: Service 41 | apiVersion: v1 42 | metadata: 43 | name: rabbitmq 44 | namespace: lodestone 45 | labels: 46 | k8s-app: rabbitmq 47 | spec: 48 | selector: 49 | k8s-app: rabbitmq 50 | ports: 51 | - protocol: TCP 52 | port: 5672 53 | targetPort: 5672 54 | name: amqp 55 | - protocol: TCP 56 | port: 15672 57 | targetPort: 15672 58 | name: mgmt 59 | -------------------------------------------------------------------------------- /docs/examples/k8s/storage.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: StatefulSet 3 | apiVersion: apps/v1 4 | metadata: 5 | name: storage 6 | namespace: lodestone 7 | labels: 8 | k8s-app: storage 9 | spec: 10 | replicas: 1 11 | serviceName: storage 12 | selector: 13 | matchLabels: 14 | k8s-app: storage 15 | volumeClaimTemplates: 16 | - metadata: 17 | name: storage 18 | spec: 19 | accessModes: 20 | - ReadWriteOnce 21 | resources: 22 | requests: 23 | storage: 5Gi 24 | template: 25 | metadata: 26 | labels: 27 | k8s-app: storage 28 | spec: 29 | securityContext: 30 | runAsUser: 0 31 | runAsGroup: 0 32 | fsGroup: 0 33 | terminationGracePeriodSeconds: 30 34 | containers: 35 | - image: analogj/lodestone:storage 36 | imagePullPolicy: Always 37 | name: storage 38 | env: 39 | - name: MINIO_BROWSER 40 | value: "off" 41 | - name: MINIO_ACCESS_KEY 42 | value: "minio" 43 | - name: MINIO_SECRET_KEY 44 | value: "minio123" 45 | - name: MINIO_NOTIFY_AMQP_ENABLE 46 | value: "on" 47 | - name: MINIO_NOTIFY_AMQP_URL 48 | value: "amqp://lodestone:lodestone@rabbitmq:5672" 49 | - name: MINIO_NOTIFY_AMQP_EXCHANGE 50 | value: "lodestone" 51 | - name: MINIO_NOTIFY_AMQP_EXCHANGE_TYPE 52 | value: "fanout" 53 | - name: MINIO_NOTIFY_AMQP_ROUTING_KEY 54 | value: "storagelogs" 55 | - name: MINIO_NOTIFY_AMQP_MANDATORY 56 | value: "off" 57 | - name: MINIO_NOTIFY_AMQP_AUTO_DELETED 58 | value: "off" 59 | - name: MINIO_NOTIFY_AMQP_DELIVERY_MODE 60 | value: "0" 61 | - name: LS_RABBITMQ_HOST 62 | value: "rabbitmq" 63 | - name: LS_RABBITMQ_PORT 64 | value: "5672" 65 | volumeMounts: 66 | - mountPath: /data 67 | name: storage 68 | ports: 69 | - containerPort: 9000 70 | securityContext: 71 | allowPrivilegeEscalation: false 72 | --- 73 | kind: Service 74 | apiVersion: v1 75 | metadata: 76 | name: storage 77 | namespace: lodestone 78 | labels: 79 | k8s-app: storage 80 | spec: 81 | selector: 82 | k8s-app: storage 83 | ports: 84 | - protocol: TCP 85 | port: 9000 86 | targetPort: 9000 87 | name: storage 88 | -------------------------------------------------------------------------------- /docs/examples/k8s/tika.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: Deployment 3 | apiVersion: apps/v1 4 | metadata: 5 | name: tika 6 | namespace: lodestone 7 | labels: 8 | k8s-app: tika 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | k8s-app: tika 14 | template: 15 | metadata: 16 | labels: 17 | k8s-app: tika 18 | spec: 19 | securityContext: 20 | runAsUser: 1000 21 | runAsGroup: 1000 22 | fsGroup: 1000 23 | terminationGracePeriodSeconds: 30 24 | containers: 25 | - image: analogj/lodestone:tika 26 | imagePullPolicy: Always 27 | name: tika 28 | ports: 29 | - containerPort: 9998 30 | securityContext: 31 | allowPrivilegeEscalation: false 32 | --- 33 | kind: Service 34 | apiVersion: v1 35 | metadata: 36 | name: tika 37 | namespace: lodestone 38 | labels: 39 | k8s-app: tika 40 | spec: 41 | selector: 42 | k8s-app: tika 43 | ports: 44 | - protocol: TCP 45 | port: 9998 46 | targetPort: 9998 47 | name: tika 48 | -------------------------------------------------------------------------------- /docs/examples/k8s/webapp.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | kind: Deployment 3 | apiVersion: apps/v1 4 | metadata: 5 | name: webapp 6 | namespace: lodestone 7 | labels: 8 | k8s-app: webapp 9 | spec: 10 | replicas: 1 11 | selector: 12 | matchLabels: 13 | k8s-app: webapp 14 | template: 15 | metadata: 16 | labels: 17 | k8s-app: webapp 18 | spec: 19 | securityContext: 20 | runAsUser: 1000 21 | runAsGroup: 1000 22 | fsGroup: 1000 23 | terminationGracePeriodSeconds: 30 24 | containers: 25 | - image: analogj/lodestone:web 26 | imagePullPolicy: Always 27 | name: webapp 28 | env: 29 | - name: MINIO_ACCESS_KEY 30 | value: "minio" 31 | - name: MINIO_SECRET_KEY 32 | value: "minio123" 33 | - name: RABBITMQ_USER 34 | value: "lodestone" 35 | - name: RABBITMQ_PASS 36 | value: "lodestone" 37 | - name: DISABLE_FRONTEND 38 | value: "true" 39 | - name: LS_ELASTICSEARCH_HOST 40 | value: "elasticsearch" 41 | - name: LS_ELASTICSEARCH_PORT 42 | value: "9200" 43 | - name: LS_RABBITMQ_HOST 44 | value: rabbitmq 45 | - name: LS_RABBITMQ_PORT 46 | value: "5672" 47 | - name: LS_RABBITMQ_MG_HOST 48 | value: "rabbitmq" 49 | - name: LS_RABBITMQ_MG_PORT 50 | value: "15672" 51 | - name: LS_STORAGE_HOST 52 | value: storage 53 | - name: LS_STORAGE_PORT 54 | value: "9000" 55 | - name: LS_STORAGE_PATH 56 | value: "/storage/" 57 | ports: 58 | - containerPort: 3000 59 | securityContext: 60 | allowPrivilegeEscalation: false 61 | --- 62 | kind: Service 63 | apiVersion: v1 64 | metadata: 65 | name: webapp 66 | namespace: lodestone 67 | labels: 68 | k8s-app: webapp 69 | spec: 70 | selector: 71 | k8s-app: webapp 72 | ports: 73 | - protocol: TCP 74 | port: 3000 75 | targetPort: 3000 76 | name: webapp 77 | -------------------------------------------------------------------------------- /docs/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/logo.png -------------------------------------------------------------------------------- /docs/screenshots/dashboard-date-filter.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/screenshots/dashboard-date-filter.png -------------------------------------------------------------------------------- /docs/screenshots/dashboard-text-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/screenshots/dashboard-text-search.png -------------------------------------------------------------------------------- /docs/screenshots/dashboard.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/screenshots/dashboard.png -------------------------------------------------------------------------------- /docs/screenshots/details.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/screenshots/details.png -------------------------------------------------------------------------------- /docs/screenshots/status.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/LodestoneHQ/lodestone/a3f943bdd3b7f7036f535c5701f161796b53070d/docs/screenshots/status.png --------------------------------------------------------------------------------