2
0
mirror of https://github.com/Shawn-Shan/fawkes.git synced 2025-04-10 06:56:58 +05:30
fawkes/fawkes/README.md
smy17 835a0624b4 update ./fawkes/README.md, add how to set up on windows
Former-commit-id: 00a9f96ae8f8bf77d0116a4ff5e0e26eb7b2f520 [formerly d49e38562079f05402645abb3956a274a67fc914]
Former-commit-id: de2553c7e79749af1d10387f76bbd48dcc5fb0cb
2020-07-11 21:29:12 +08:00

2.1 KiB

Fawkes Binary

This application is built for individuals to cloak their images before uploading to the Internet. For more information about the project, please refer to our project webpage.

If you are a developer or researcher planning to customize and modify on our existing code. Please refer to fawkes.

How to Setup

MAC:

  • Download the binary following this link and unzip the download file.
  • Create a directory and move all the images you wish to protect into that directory. Note the path to that directory (e.g. ~/Desktop/images).
  • Open terminal and change directory to fawkes (the unzipped folder).
  • (If your MacOS is Catalina) Run sudo spctl --master-disable to enable running apps from unidentified developer. We are working on a solution to bypass this step.
  • Run ./fawkes -d IMAGE_DIR_PATH -m low to generate cloak for images in IMAGE_DIR_PATH.
  • When the cloaked image is generated, it will output a *_low_cloaked.png image in IMAGE_DIR_PATH. The generation takes ~40 seconds per image depending on the hardware.
  • More details on the optional parameters check out the github repo.

PC:

  • Download the binary following this link and unzip the download file.
  • Create a directory and move all the images you wish to protect into that directory. Note the path to that directory (e.g. ~/Desktop/images).
  • Open terminal(powershell or cmd) and change directory to fawkes (the unzipped folder).
  • Run protection -d IMAGE_DIR_PATH -m low to generate cloak for images in IMAGE_DIR_PATH.
  • When the cloaked image is generated, it will output a *_low_cloaked.png image in IMAGE_DIR_PATH. The generation takes ~40 seconds per image depending on the hardware.
  • More details on the optional parameters check out the github repo.