Hello,
as a new user of OGHarn, I encountered some difficulties installing the environment installation as described in the ReadMe using the provided Dockerfile.
- The first challenge was executing the
extras/set_env.sh script correctly.
From the ReadMe:
To install them, run either /extras/install_dependencies.sh, or use our available Dockerfile.
Once Multiplier and AFL++ are installed to /extras, run /extras/set_env.sh to:
This suggests building the Docker image, starting the container, connecting to the container, and running something (not defined) like ./extras/set_env.sh.
I recommend explicitly instructing users to run . ./extras/set_env.sh to execute the script (and work with the settings) in the current shell. I would prefer . over source, since OGHarn does not know which shell the user has got.
-
I recommend appending source /OGHarn/extras/.venv/bin/activate to the file set_env.sh, so that after execution the Python virtual environment is always activated in a new shell. Users who disconnect from the container and reconnect later would benefit from this automation. The venv activation in the Dockerfile would become obsolete.
-
Just for your interest, since I touched the Dockerfile: The Dockerfile linting tool hadolint simplifies the implementation of best practices for Dockerfiles and could help improve the quality of OGHarn's code.
Thank you very much!
My OGHarn version: 5383b70f04891f7fb23b6af1ec8d5c754af3f6a1
Hello,
as a new user of OGHarn, I encountered some difficulties installing the environment installation as described in the ReadMe using the provided Dockerfile.
extras/set_env.shscript correctly.From the ReadMe:
This suggests building the Docker image, starting the container, connecting to the container, and running something (not defined) like
./extras/set_env.sh.I recommend explicitly instructing users to run
. ./extras/set_env.shto execute the script (and work with the settings) in the current shell. I would prefer.oversource, since OGHarn does not know which shell the user has got.I recommend appending
source /OGHarn/extras/.venv/bin/activateto the fileset_env.sh, so that after execution the Python virtual environment is always activated in a new shell. Users who disconnect from the container and reconnect later would benefit from this automation. The venv activation in theDockerfilewould become obsolete.Just for your interest, since I touched the
Dockerfile: The Dockerfile linting tool hadolint simplifies the implementation of best practices for Dockerfiles and could help improve the quality of OGHarn's code.Thank you very much!
My OGHarn version:
5383b70f04891f7fb23b6af1ec8d5c754af3f6a1