Skip to content

Commit

Permalink
add: [core] Installation instruction verified (Ubuntu 18.xx Server LTS)
Browse files Browse the repository at this point in the history
  • Loading branch information
Vincent-CIRCL committed May 27, 2019
1 parent 18a482f commit e6ee03b
Show file tree
Hide file tree
Showing 4 changed files with 123 additions and 51 deletions.
1 change: 1 addition & 0 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ flask = "*"
pyopenssl = "*"
redis = "*"
objsize = "*"
requests = "*"

[requires]
python_version = "3.7"
114 changes: 67 additions & 47 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

50 changes: 46 additions & 4 deletions installation_info.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
## Installation

Just follow instruction, top to bottom

### Core product

< To be detailed >
> \# Install system dependency
> sudo apt-get install python3.7 python3.7-dev libsm6 libxrender1 cmake
>
> \# Prepare pipenv
> sudo apt install python3-pip
> sudo pip3 install pipenv
>
> \# Get repository
> git clone https://github.com/CIRCL/douglas-quaid.git
>
> \# Pipenv setup
> cd ./douglas-quaid/
> pipenv install --ignore-pipfile
>
> \# Setup your carlhauser path
> export CARLHAUSER_HOME='/home/user/douglas-quaid'
> PLEASE BE AWARE TO CHANGE THE PATH TO THE CURRENT INSTALLATION PATH.
> THIS IS ABSOLUTELY REQUIRED FOR THE LIBRARY TO WORK !
### Dependencies

#### TLSH
> \# TLSH instructions
> \# Go in the pipenv shell
> pipenv shell
> chmod +x ./tlsh_install.sh
> sudo ./tlsh_install.sh
#### Launch instruction
#### Redis
> \# Install system dependency
> sudo apt-get install redis

### Launch instruction
From root folder :

> cd ./lib_testing_area/
> python3 ./launcher.py
#### Server side API
> cd ./carlhauser_server
> pipenv run python3 ./core.py
OR
> screen -S server-api pipenv run python3 ./core.py
#### Client side API
> cd ./carlhauser_client
> pipenv run python3 ./core.py
OR
> screen -S client-api pipenv run python3 ./core.py
9 changes: 9 additions & 0 deletions tlsh_install.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash
git clone https://github.com/trendmicro/tlsh
cd ./tlsh
./make.sh
cd py_ext/
python3 ./setup.py build
python3 ./setup.py install
cd ../Testing
./python_test.sh

0 comments on commit e6ee03b

Please sign in to comment.