{"id":19560343,"url":"https://github.com/cybercentrecanada/assemblyline-service-document-preview","last_synced_at":"2026-01-29T22:08:43.202Z","repository":{"id":37898343,"uuid":"340012861","full_name":"CybercentreCanada/assemblyline-service-document-preview","owner":"CybercentreCanada","description":"Assemblyline 4 Document preview service","archived":false,"fork":false,"pushed_at":"2025-11-10T18:01:43.000Z","size":336,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-11-10T20:08:08.492Z","etag":null,"topics":["assemblyline","malware-analysis"],"latest_commit_sha":null,"homepage":"https://cybercentrecanada.github.io/assemblyline4_docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CybercentreCanada.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-02-18T10:24:44.000Z","updated_at":"2025-10-21T20:09:52.000Z","dependencies_parsed_at":"2023-02-02T20:46:07.429Z","dependency_job_id":"4c33dd97-9c29-4680-a7f9-833ae4cf89b0","html_url":"https://github.com/CybercentreCanada/assemblyline-service-document-preview","commit_stats":null,"previous_names":[],"tags_count":345,"template":false,"template_full_name":null,"purl":"pkg:github/CybercentreCanada/assemblyline-service-document-preview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-service-document-preview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-service-document-preview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-service-document-preview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-service-document-preview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CybercentreCanada","download_url":"https://codeload.github.com/CybercentreCanada/assemblyline-service-document-preview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CybercentreCanada%2Fassemblyline-service-document-preview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28886969,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-29T21:06:44.224Z","status":"ssl_error","status_checked_at":"2026-01-29T21:06:42.160Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["assemblyline","malware-analysis"],"created_at":"2024-11-11T05:07:17.163Z","updated_at":"2026-01-29T22:08:43.179Z","avatar_url":"https://github.com/CybercentreCanada.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Discord](https://img.shields.io/badge/chat-on%20discord-7289da.svg?sanitize=true)](https://discord.gg/GUAy9wErNu)\n[![](https://img.shields.io/discord/908084610158714900)](https://discord.gg/GUAy9wErNu)\n[![Static Badge](https://img.shields.io/badge/github-assemblyline-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline)\n[![Static Badge](https://img.shields.io/badge/github-assemblyline\\_service\\_document\\_preview-blue?logo=github)](https://github.com/CybercentreCanada/assemblyline-service-document-preview)\n[![GitHub Issues or Pull Requests by label](https://img.shields.io/github/issues/CybercentreCanada/assemblyline/service-document-preview)](https://github.com/CybercentreCanada/assemblyline/issues?q=is:issue+is:open+label:service-document-preview)\n[![License](https://img.shields.io/github/license/CybercentreCanada/assemblyline-service-document-preview)](./LICENSE)\n# DocumentPreview Service\n\nThis Assemblyline service renders documents for preview and performs OCR analysis for malicious content.\n\n## Service Details\n\n### OCR\nThis uses OCR for it's analysis, you can find information about OCR configurations [here](https://cybercentrecanada.github.io/assemblyline4_docs/administration/service_management/#ocr-configuration).\n\n## Accreditation / Contributions\nThis Assemblyline service is based on [FAME's module](https://github.com/certsocietegenerale/fame_modules/tree/master/processing/document_preview).\nIt was originally created by [x1mus](https://github.com/x1mus) with support from [Sorakurai](https://github.com/Sorakurai) and [reynas](https://github.com/reynas) at [NVISO](https://github.com/NVISOsecurity).\n\nThis also contains modified source code from the following repositories:\n- [XME's emlrender](https://github.com/xme/emlrender)\n- [JoshData's convert-outlook-msg-file](https://github.com/JoshData/convert-outlook-msg-file)\n\n## Image variants and tags\n\nAssemblyline services are built from the [Assemblyline service base image](https://hub.docker.com/r/cccs/assemblyline-v4-service-base),\nwhich is based on Debian 11 with Python 3.11.\n\nAssemblyline services use the following tag definitions:\n\n| **Tag Type** | **Description**                                                                                  |      **Example Tag**       |\n| :----------: | :----------------------------------------------------------------------------------------------- | :------------------------: |\n|    latest    | The most recent build (can be unstable).                                                         |          `latest`          |\n|  build_type  | The type of build used. `dev` is the latest unstable build. `stable` is the latest stable build. |     `stable` or `dev`      |\n|    series    | Complete build details, including version and build type: `version.buildType`.                   | `4.5.stable`, `4.5.1.dev3` |\n\n## Running this service\n\nThis is an Assemblyline service. It is designed to run as part of the Assemblyline framework.\n\nIf you would like to test this service locally, you can run the Docker image directly from the a shell:\n\n    docker run \\\n        --name DocumentPreview \\\n        --env SERVICE_API_HOST=http://`ip addr show docker0 | grep \"inet \" | awk '{print $2}' | cut -f1 -d\"/\"`:5003 \\\n        --network=host \\\n        cccs/assemblyline-service-document-preview\n\nTo add this service to your Assemblyline deployment, follow this\n[guide](https://cybercentrecanada.github.io/assemblyline4_docs/developer_manual/services/run_your_service/#add-the-container-to-your-deployment).\n\n## Documentation\n\nGeneral Assemblyline documentation can be found at: https://cybercentrecanada.github.io/assemblyline4_docs/\n\n# Service DocumentPreview\n\nCe service d'Assemblyline exécute le rendement des documents pour prévisualisation et effectue une analyse OCR pour détecter les contenus malveillants.\n\n\n## Détails du service\n\n### OCR\nCe service utilise l'OCR pour son analyse. Vous pouvez trouver les détails de configurations de l'OCR [ici] (https://cybercentrecanada.github.io/assemblyline4_docs/administration/service_management/#ocr-configuration).\n\n## Accréditation / Contributions\nCe service Assemblyline est basé sur le module [FAME] (https://github.com/certsocietegenerale/fame_modules/tree/master/processing/document_preview).\nIl a été créé à l'origine par [x1mus](https://github.com/x1mus) avec le soutien de [Sorakurai](https://github.com/Sorakurai) et [reynas](https://github.com/reynas) à [NVISO](https://github.com/NVISOsecurity).\n\nIl contient également du code source modifié provenant des dépôts suivants :\n- [emlrender de XME](https://github.com/xme/emlrender)\n- [convert-outlook-msg-file de JoshData](https://github.com/JoshData/convert-outlook-msg-file)\n\n## Variantes et étiquettes d'image\n\nLes services d'Assemblyline sont construits à partir de l'image de base [Assemblyline service](https://hub.docker.com/r/cccs/assemblyline-v4-service-base),\nqui est basée sur Debian 11 avec Python 3.11.\n\nLes services d'Assemblyline utilisent les définitions d'étiquettes suivantes:\n\n| **Type d'étiquette** | **Description**                                                                                                |  **Exemple d'étiquette**   |\n| :------------------: | :------------------------------------------------------------------------------------------------------------- | :------------------------: |\n|   dernière version   | La version la plus récente (peut être instable).                                                               |          `latest`          |\n|      build_type      | Type de construction utilisé. `dev` est la dernière version instable. `stable` est la dernière version stable. |     `stable` ou `dev`      |\n|        série         | Détails de construction complets, comprenant la version et le type de build: `version.buildType`.              | `4.5.stable`, `4.5.1.dev3` |\n\n## Exécution de ce service\n\nCe service est spécialement optimisé pour fonctionner dans le cadre d'un déploiement d'Assemblyline.\n\nSi vous souhaitez tester ce service localement, vous pouvez exécuter l'image Docker directement à partir d'un terminal:\n\n    docker run \\\n        --name DocumentPreview \\\n        --env SERVICE_API_HOST=http://`ip addr show docker0 | grep \"inet \" | awk '{print $2}' | cut -f1 -d\"/\"`:5003 \\\n        --network=host \\\n        cccs/assemblyline-service-document-preview\n\nPour ajouter ce service à votre déploiement d'Assemblyline, suivez ceci\n[guide](https://cybercentrecanada.github.io/assemblyline4_docs/fr/developer_manual/services/run_your_service/#add-the-container-to-your-deployment).\n\n## Documentation\n\nLa documentation générale sur Assemblyline peut être consultée à l'adresse suivante: https://cybercentrecanada.github.io/assemblyline4_docs/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcybercentrecanada%2Fassemblyline-service-document-preview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcybercentrecanada%2Fassemblyline-service-document-preview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcybercentrecanada%2Fassemblyline-service-document-preview/lists"}