Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cybercentrecanada/assemblyline-docker-compose

Docker compose Assemblyline 4 deployment (appliance and development)
https://github.com/cybercentrecanada/assemblyline-docker-compose

assemblyline docker docker-compose malware-analysis

Last synced: 5 days ago
JSON representation

Docker compose Assemblyline 4 deployment (appliance and development)

Awesome Lists containing this project

README

        

## Assemblyline 4 - Docker compose documentation

There are two types of configuration possible:

- Minimal appliance
- Full Appliance

```NOTE:``` Appliances are built on top of docker but for the moment they do not support Docker in swarm mode.

### Minimal Appliance

This setup includes the bare-minimum components for everything to be able to run. There will be no metrics collected and you will have to tail the log from the docker container logs.

### Full Appliance

This setup includes every single components and all metrics and logging capabilities. Metrics and logs will be gathered inside the same Elasticsearch instance as the processing data and you will have access kibana to view all of those.

## Setup

For full documentation on how to setup an assemblyline appliance see the documentation page.
https://cybercentrecanada.github.io/assemblyline4_docs/

#### Quickstart

##### 1. Install docker and docker-compose on a linux system
```NOTE:``` If using the Docker Compose plugin, replace `docker-compose` commands with `docker compose`.

##### 2. Clone this repository
```bash
git clone https://github.com/CybercentreCanada/assemblyline-docker-compose.git
```

##### 3. Choose deployment type
Choose one of the minimal or full deployments. The rest of the commands
and paths given will be relative to the directory specific to the deployment
type you are doing.
```bash
mkdir ~/deployments
cp -R ~/git/assemblyline-docker-compose/minimal_appliance ~/deployments/assemblyline
cd ~/deployments/assemblyline
```

or

```bash
mkdir ~/deployments
cp -R ~/git/assemblyline-docker-compose/full_appliance ~/deployments/assemblyline
cd ~/deployments/assemblyline
```

##### 4. Set domain, passwords, and paths in `./.env` and `./config/bootstrap.py`

##### 5. Copy in an existing or generate a self-signed certificate into the `./config` directory in the cloned repository
```bash
source .env
openssl req -nodes -x509 -newkey rsa:4096 -keyout ./config/nginx.key -out ./config/nginx.crt -days 365 -subj "/C=CA/ST=Ontario/L=Ottawa/O=CCCS/CN=$DOMAIN"
```

##### 6. Launch the system
Pull the containers.
```bash
sudo docker-compose pull
sudo docker-compose build
sudo docker-compose -f bootstrap-compose.yaml pull
```
Launch the core system.
```bash
sudo docker-compose up -d
```
Perform first time only setup and service initialization.
```bash
sudo docker-compose -f bootstrap-compose.yaml up
```