{"id":16133445,"url":"https://github.com/deckerego/docmag","last_synced_at":"2025-03-18T15:31:03.290Z","repository":{"id":26189997,"uuid":"107201645","full_name":"deckerego/docmag","owner":"deckerego","description":"The web UI for Facile Search. Together with DocIndex, this UI can help you search the myriad of scanned documents you have been accumulating over the years. Using the power of Docker \u0026 Elasticsearch you can run a powerful search engine that lets you convert scanned (image-based) PDFs to searchable text, group documents by letterhead, run fuzzy searches by date and view document metadata.","archived":true,"fork":false,"pushed_at":"2025-03-05T21:39:38.000Z","size":2586,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T21:21:24.898Z","etag":null,"topics":["docker","elasticsearch","full-text-search","kubernetes","pdf","scanned-documents"],"latest_commit_sha":null,"homepage":"https://github.com/deckerego/docmag/wiki","language":"Groovy","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deckerego.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-17T01:20:04.000Z","updated_at":"2025-03-05T21:40:00.000Z","dependencies_parsed_at":"2022-08-07T11:16:29.120Z","dependency_job_id":"80948ee6-cdff-4ada-b353-2a8d0f427977","html_url":"https://github.com/deckerego/docmag","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deckerego%2Fdocmag","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deckerego%2Fdocmag/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deckerego%2Fdocmag/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deckerego%2Fdocmag/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deckerego","download_url":"https://codeload.github.com/deckerego/docmag/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244249176,"owners_count":20422920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","elasticsearch","full-text-search","kubernetes","pdf","scanned-documents"],"created_at":"2024-10-09T22:44:43.788Z","updated_at":"2025-03-18T15:31:03.285Z","avatar_url":"https://github.com/deckerego.png","language":"Groovy","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Facile Search\n\n**--\u003e DocMag and DocIndex have been retired - take a look at [Paperless-ngx](https://docs.paperless-ngx.com/) as a replacement. \u003c--**\n\nFacile Search bundles together Elasticsearch and DocIndex\nto make searching across documents simple and efficient.\n\n## Requirements\n\nUsually you won't want to build and run docmag locally, instead it is best to\nrun the docker container published at: https://hub.docker.com/r/deckerego/docmagui/\n\nTo run the containers needed for Facile Search you have three recommended options:\n1. [Running on a single server with Docker Compose](docs/docker_compose.md)\n1. [Installing within a cluster using Kubernetes and Helm](docs/kubernetes.md)\n1. [Installing on a Synology NAS device](docs/synology.md)\n\nSee the [docs/](docs/) directory for instructions on installation and setup on these platforms.\n\n\n## Using DocIndex to Index Files\n\nThe docidx daemon indexes files within Elasticsearch and prepares them for display - this is the\nprocess that feeds docmag. More info is available at https://github.com/deckerego/docidx\n\n\n## Building and Testing Locally\n\nBuilding the app and its necessary infrastructure locally is performed with\nMaven and `docker-compose`.\n\nTo compose the necessary containers and configure Elasticsearch indexes:\n\n    mvn install\n    export DOCUMENT_HOST_DIR=/mnt/documents \u0026\u0026 docker-compose -f docker-compose.yml -f docker-compose-devel.yml up -d\n    cd es/\n    ./configure.sh\n\nThe development instance of the composition config will expose Elasticsearch,\nSpring Boot, and Kibana to local ports - so don't use this in a\nproduction setting.\n\nThis should build \u0026 run the necessary containers, then begin indexing documents\nfrom the directory specified as `DOCUMENT_HOST_DIR`. To shut down and delete the\nElasticsearch metadata generated from these containers, execute:\n\n    export DOCUMENT_HOST_DIR=/mnt/documents \u0026\u0026 docker-compose -f docker-compose.yml -f docker-compose-devel.yml down -v\n\n\n## Searching and Querying Documents\n\nTo search within your documents, view thumbnails and open the full document\nnavigate to `http://localhost:1080`. This should take you to the main search\ninterface, which will perform a full text search on your indexed documents.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeckerego%2Fdocmag","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeckerego%2Fdocmag","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeckerego%2Fdocmag/lists"}