# Assemblyline-service-characterize

Assemblyline-service-characterize is a self-hosted security app. Characterize is an add-on for the Assemblyline security system. It is open source and self-hosted, installable on Docker Hub.

Canonical page: https://ourlocalhost.com/app/6385/assemblyline-service-characterize

## Description

Characterize is an add-on for the Assemblyline security system. It automatically analyses files to identify their true type, extracts hidden descriptive information (metadata), and measures how randomised the data is (entropy). This helps identify if a file is suspicious, encrypted, or disguised to hide its purpose.

## Platform availability

Available on 0 of 10 platforms.

## Health score

35/100 (Low), based on 4 of 4 factors.
- Maintained: 68 (last commit 72 days ago)
- Popular: 6 (1 GitHub stars)
- Easy to install: 25 (0 install platforms, install notes, Docker image)
- Light to run: 10 (8 GB minimum RAM)

## Links

- Official website: https://cybercentrecanada.github.io/assemblyline4_docs/
- GitHub: https://github.com/CybercentreCanada/assemblyline-service-characterize
- Docker Hub: https://hub.docker.com/r/cccs/assemblyline-service-characterize
- Documentation: https://cybercentrecanada.github.io/assemblyline4_docs/

## Common questions

### Can I test Characterize without a full Assemblyline deployment?

Yes, run the Docker image directly from a shell with the SERVICE_API_HOST environment variable set to the Assemblyline service API address on port 5003 and the host network.

### Which Docker tag should I choose for Characterize updates?

Use the stable tag for the latest stable build and the dev tag for the latest unstable build; latest can be unstable.

### What file must exist for the Assemblyline core to run the Characterize service?

Every Assemblyline service must have a service_manifest.yml file in its root directory, and the core needs that manifest before running the service.

---
Source: Our Local Host (https://ourlocalhost.com/app/6385/assemblyline-service-characterize), the self-hosted and open-source app directory.
