fuiny / binarydoc-docker Goto Github PK

View Code? Open in Web Editor NEW

6.0 2.0 6.0 66 KB

Docker image source code for Fuiny BinaryDoc

Home Page: https://hub.docker.com/r/fuiny/binarydoc

License: Apache License 2.0

Dockerfile 6.33% Shell 7.77% PHP 85.90%

binary documentor binarydoc java diagram uml jvm-bytecode jvm-languages jvm

binarydoc-docker's Introduction

BinaryDoc, Binary code is the best Document

BinaryDoc generates Documents with rich diagrams from Binary files directly for Java.

This docker image needs to work together with mysql database with specified mysql.cnf configurations. An sample docker-compose.yml file has been provided.

Sample Diagrams in Generated documents:

Control Flow Graph for Java method bytecode
UML Sequence Diagram for Java method bytecode
UML Hierarchy Diagram for Java Class
Dependency Network diagram for Java package
Jar,Jmod files Dependency Network Diagram (sfdp layout)

There are web sites containing the documentes and diagrams generated by BinaryDoc:

BinaryDoc Docker Compose User Guide

This is an sample docker compose setup for BinaryDoc, which generates Documents with rich diagrams from Binary files directly for Java.

docker-compose.yml

Warning

This docker compose setup is designed for none-production environment, better for evaluation or testing box
Password is set in .env, while password vault could be used in production
Default RAM in mysql.cnf is small, while 128 GB or more RAM is available in production

Hardware Requirement

BinaryDoc is a compute-intensive software which needs powerful hardware.

Here we list the suggested minimal hardware requirements:

CPU: 8 or more threads
RAM: 24 GB minimal, 64 GB is suggested for better performance, based on the size of the Java application to be parsed
Disk type: SSD Drive is suggested, M.2 SSD or NVMe SSD are preferred
Disk size: 20 GB or more avialbe disk space is suggested
- The size is based on the binary data to be parsed.
- Example: OpenJDK 11 binary data size is 387.9 MB, and the current corresponding DB size is 7 GB.

Steps

Customize the config files

.env
- Change the DB password (default=123456) when needed
- Change the TCP ports when needed
mysql.cnf
- Change innodb_buffer_pool_size based on avabile RAM hardware and the size of application to be parsed
- Change innodb_buffer_pool_instances based on parallel workloads

If running Docker on Windows

If running on other system, ignore this step
Change the file etc/mysql/conf.d/mysql.cnf permission as read only, or else the mysql file will not load it

Start the Docker Instances

docker-compose up -d

Run the Parser for current OpenJDK for demo:

./run-parse-demo.sh
- Note. the parser execution takes about 1 hour on M.2 SSD disk, and needs up to 24 GB RAM

Run the Parser for your application:

Put your Java Application to be Parsed to the app-to-parse folder
- Example: Copy the application .jmod or .jar files to this folder
Start the parser
- ./run-parse-app.sh

Access the Web Site

http://127.0.0.1:10180/

(Optional) Access the Backend DB if interested

http://127.0.0.1:10190/
- System: MySQL
- Server: binarydoc-db
- Username: root
- Password: 123456, or the password set in the .env file
- Database: binarydocjvmadm
MySQL Workbench, or Other DB Access Tools
- Server: localhost
- Port: 13306

Other commands

When we want to Delete Existing Docker Instances, and to Start over again

./rebuild.sh

When we want login to the Running Docker container

sudo docker-compose exec binarydoc /bin/bash

TCP Ports Mapping

We may change the ports 10180, 10190, 13306 in .env when necessary

Community

Support: Report Issues in Github
License: Apache License 2.0

binarydoc-docker's People

Contributors

Stargazers

Watchers

Forkers

yashness rebeltat mentoring-self b1974jae alexrogalskiy officehero

binarydoc-docker's Issues

Upgrade to BinaryDoc 4.x

OS to Ubuntu 20.04
Application code upgrade to 4.x version

Upgrade to BinaryDoc 5.x

UI Bootstrap 5.x, Tabulator 5.x
Features
- JVM Doc
- Annotations Doc
- Diff Doc
- Local Search
Supports
- External API
- Graphdb for Xref

Add Project to https://www.binarydoc.org/ ?

Hi,

would it be possible to add Apache Isis to the projects hosted on binarydoc.org?
See: https://mvnrepository.com/artifact/org.apache.isis/isis-parent

Best regards
Jörg

docker-compose sample

Merge the sample docker-compose files to this repo

Loop / Permanent Restart

Hi,

thanks for providing binarydoc!

When I execute rebuild.sh (git bash under windows 10), I see the following in the console of fuiny/binarydoc:latest:

spawn mysql_config_editor set --login-path=binarydocjvm --host=binarydoc-db --user=root --password
Enter password:
spawn mysql_config_editor set --login-path=binarydocjvmadm --host=binarydoc-db --user=root --password
Enter password:
Thu Mar 25 15:27:23 UTC 2021 Waiting for DB to be Ready ...
[...]
Thu Mar 25 15:28:02 UTC 2021 DB Server is NOT ready yet
mysqld is alive
Thu Mar 25 15:28:03 UTC 2021 DB Server is ready now
Thu Mar 25 15:28:06 UTC 2021 Create DB Users if not exist
host user authentication_string
% fuinyadmin *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
% fuinyweb *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
% root *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
localhost mysql.infoschema $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost mysql.session $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost mysql.sys $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost root *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
Thu Mar 25 15:28:06 UTC 2021 Create DB Schema for Admin if not exists
ERROR 1418 (HY000) at line 206: This function has none of DETERMINISTIC, NO SQL, or READS SQL DATA in its declaration and binary logging is enabled (you *might* want to use the less safe log_bin_trust_function_creators variable)
spawn mysql_config_editor set --login-path=binarydocjvm --host=binarydoc-db --user=root --password
Enter password:
spawn mysql_config_editor set --login-path=binarydocjvmadm --host=binarydoc-db --user=root --password
Enter password:
Thu Mar 25 15:28:08 UTC 2021 Waiting for DB to be Ready ...
mysqld is alive
Thu Mar 25 15:28:08 UTC 2021 DB Server is ready now
Thu Mar 25 15:28:11 UTC 2021 Create DB Users if not exist
host user authentication_string
% fuinyadmin *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
% fuinyweb *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
% root *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
localhost mysql.infoschema $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost mysql.session $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost mysql.sys $A$005$THISISACOMBINATIONOFINVALIDSALTANDPASSWORDTHATMUSTNEVERBRBEUSED
localhost root *6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
Thu Mar 25 15:28:12 UTC 2021 Create DB Schema for Admin if not exists
ERROR 1418 (HY000) at line 206: This function has none of DETERMINISTIC, NO SQL, or READS SQL DATA in its declaration and binary logging is enabled (you *might* want to use the less safe log_bin_trust_function_creators variable)
[...]

docker version shows:

Client: Docker Engine - Community
 Cloud integration: 1.0.9
 Version:           20.10.5
 API version:       1.41
 Go version:        go1.13.15
 Git commit:        55c4c88
 Built:             Tue Mar  2 20:14:53 2021
 OS/Arch:           windows/amd64
 Context:           default
 Experimental:      true

Server: Docker Engine - Community
 Engine:
  Version:          20.10.5
  API version:      1.41 (minimum version 1.12)
  Go version:       go1.13.15
  Git commit:       363e9a8
  Built:            Tue Mar  2 20:15:47 2021
  OS/Arch:          linux/amd64
  Experimental:     false
 containerd:
  Version:          1.4.3
  GitCommit:        269548fa27e0089a8b8278fc4fc781d7f65a939b
 runc:
  Version:          1.0.0-rc92
  GitCommit:        ff819c7e9184c13b7c2607fe6c30ae19403a7aff
 docker-init:
  Version:          0.19.0
  GitCommit:        de40ad0

Am I doing something wrong?

Thanks in advance
Jörg

Setup the BinaryDoc Docker Image

Set up the docker image for BinaryDoc product

Update mysql innodb_redo_log_capacity

https://dev.mysql.com/doc/refman/8.0/en/innodb-redo-log.html

From MySQL 8.0.30, the innodb_redo_log_capacity system variable controls the amount of disk space occupied by redo log files.
The innodb_redo_log_capacity variable supersedes the innodb_log_files_in_group and innodb_log_file_size variables, which are deprecated. When the innodb_redo_log_capacity setting is defined, the innodb_log_files_in_group and innodb_log_file_size settings are ignored; otherwise, these settings are used to compute the innodb_redo_log_capacity setting (innodb_log_files_in_group * innodb_log_file_size = innodb_redo_log_capacity).