Skip to content

Installation Guide

Mayank Kumar edited this page Oct 2, 2021 · 9 revisions

Welcome to the Kryptonite installation guide. Please read this guide in full and carefully before actually beginning the process.

Disclaimer

As with most open source software hacks, you use this software at your own risk. Kryptonite uses OpenCore to inject patches via EFI. Please keep in mind that while these packages are tested extensively, there is always an extremely small chance something could go wrong and brick your device.

Step 1: Review Compatibility

Ensure that your system supports eGPUs and Kryptonite: https://github.com/mayankk2308/kryptonite/wiki/Compatibility

Step 2: Initial Preparations

  1. Always keep a backup of all your data.
  2. See the Preparing Your System page for next steps.

Step 3: Security Features

If you are using a Mac with T2 chip, set startup security to No Security: https://support.apple.com/en-us/HT208198

All other security features can remain enabled. All other Macs can work with all security features enabled.

Step 4: Prepare OpenCore Volume

If you already have an OpenCore installation, back up your config.plist file. Otherwise, please follow instructions at Create OpenCore Disk.

Step 5: Run Kryptonite Installer

  1. Launch Terminal and execute the installer as follows:

    cd ~/Downloads; curl -qLs https://github.com/mayankk2308/kryptonite/raw/main/Installer/Installer.zip -o Installer.zip; ditto -x -k Installer.zip .; cd Installer; chmod +x installer.sh; ./installer.sh; cd ../; rm -rf Installer*
  2. You will be asked if you are already using OpenCore or not. Choose [Y]es if you do, [N]o if not.

    • If you chose [Y]es, you will be asked to provide your OpenCore volume path.
    • If you chose [N]o, you will be asked to select a disk to format. Choose the one you created in Step 4.

    If you want to upgrade Kryptonite:

    • Choose [Y]es to upgrade only the Kryptonite kext (such as when using custom configuration/OCLP) to not overwrite your other configurations.
    • Choose [N]o to upgrade all components - you disk will be reformatted and any custom configuration will be lost.
  3. You will be asked if you want to use DEBUG resources - choose [N]o unless you want to generate logs or are facing issues.

  4. You will be asked if you are using an NVIDIA GPU - choose [Y]es if you are using a compatible NVIDIA GPU, otherwise [N]o.

  5. Depending on your system, you will be asked if you want to disable your internal GPU to enable display output on your eGPU - choose accordingly.

  6. Review you configuration and press [Y]es to proceed with the setup.

If you do not want to use the installer, please read Kext Configuration to understand how to configure Kryptonite. Please refer to OpenCore documentation on how to edit config.plist, inject kexts, and any other things you need to achieve your ideal configuration.

Step 6: Prepare System For Boot

  1. After the setup process completes, restart your Mac while holding OPTION key.
  2. Use arrow keys to select Kryptonite boot disk.
  3. Press CTRL + ENTER to set it as default boot disk.
  4. You can boot into any of your macOS installations via the OpenCore boot picker.

Step 7: Post-Install

Review Compatibility. For some NVIDIA GPUs, you will require NVIDIA Web Drivers. If your GPU needs it, please install them via Terminal as follows:

bash <(curl -s https://raw.githubusercontent.com/Benjamin-Dobell/nvidia-update/master/nvidia-update.sh)

Then reboot your system.

To make further enhancements to your setup, please look at the Post-Install section. This includes information about disabling internal GPUs, skipping the boot picker on every boot to directly boot into macOS, additional configuration for Bootcamp users to combat error 12, and more.

If you are facing issues, see Debugging section before opening an issue.

If you need to uninstall, please follow the Uninstallation steps.

Message to Users

  • See Pages above for all available topics.
  • Please read all topics carefully.
  • If you have questions, see FAQ first.
  • Reach out for help on egpu.io if required.
Clone this wiki locally