Skip to content

Commit

Permalink
Inital import of Post Install Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
khronokernel committed Jul 9, 2020
1 parent 889e247 commit c7e4c80
Show file tree
Hide file tree
Showing 95 changed files with 2,161 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_book/
node_modules/
.vscode/
.DS_Store
package-lock.json
8 changes: 8 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"default": true,
"line_length": false,
"no-alt-text": false,
"no-inline-html": false,
"header-increment": false,
"no-duplicate-header": false
}
9 changes: 9 additions & 0 deletions .markdownlintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/node_modules/
/_book/
*.json
/extra-files/
/.git/
/icons/
/images/
/styles/
.travis.yml
21 changes: 21 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
language: node_js
node_js: lts/*
cache:
npm: false
before_script:
- npm install -g gitbook-cli
script:
- gitbook install
- gitbook build
- cp icons/* _book/gitbook/images
deploy:
local_dir: _book
provider: pages
skip_cleanup: true
name: Travis Build Bot
keep_history: true
on:
branch: master
target_branch: gh-pages
github_token:
secure: huaXIb+EhuAbwdZZuEGjJ7UqP/o7/kf9gf3YGfao4cxeTr29oNFaSDwvQVh2YbOW5wLcberSyNxad+iP6u6U5ZHYMDR15DravIDd32ZrSWc+6Ws4b2VG026ZhsZgY4Vhgbg48T96rywi+7cTasWTICRburvz7r8UOf8EwU+TKtSBCPTziKhakBIRAeFExp2qcLajtFzl/2qhL1hfL20stF7Lc8IWERoTwnVLT6BgqTrqf04I71N+hEMfFZYtZ1YkbZJeKUi4fJsF1T5Vb6l6ta73ixk6hIhOWJfi4bNB4kS+6lnUVDvrK9E+jSu+iE5nlId9wHxOPlsslmDmTNJrwlY6CxeE6Oa2kOSImPxO25UJ6GPqWBxzn+uYde01uFNuYIK1ebbDwZftiaJlkMTsPsM+AKdPffF/Uo6MeCrBQa/rV7vdnimgKRGcK6OCRPNcb44gNPXeY/o7B9F9a5bZOiiytZDTQ5XJ0ohqeOc+VFtbZ7khj9qvfhVPX/a2JIYk2BiWXluXq2xlvEPNyxGrsT5yR78LYA9v8jiGRTl0kynPj/V/g4kFhLc3JPhs8TxVVgIXCM8H0KdVu2ijHBOUHrT6OwLiCfNHXlquuJVVLsj+e+8Hlbbq/44LvLa9L92QLufZWnBVtBtV9tV+wsi93JZQsxskqv2W5n064CcGA8k=
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,77 @@
# OpenCore-Post-Install

Welcome to the OpenCore Post-Install guide! Please note that if you have not installed macOS yet, we recommend you follow one of our install guides:

* [OpenCore Desktop Guide](https://dortania.github.io/OpenCore-Desktop-Guide/)
* [OpenCore Laptop Guide](https://dortania.github.io/vanilla-laptop-guide/)

And while the info here can be applied to both OpenCore and Clover, we primarily focus on OpenCore installations. So you will need to research a bit more if you run into any issues.



## How to follow this guide


To start, not every section in this guide must be complete. It's up to each user whether they feel they want to add the finishing touches or resolve certain issues

This guide is split into 4 parts:

* [Universal](#universal)
* All users are recommended to follow
* [Laptop Specifics](#laptop-specifics)
* Laptop users are recommended to follow in addition to the above
* [Cosmetics](#cosmetics)
* Cosmetics like OpenCore GUI and removing verbose screen output during boot
* [Multiboot](#multiboot)
* Recommendations for users who are multi-booting
* [Miscellaneous](#miscellaneous)
* Other misc fixes, not all users will require these fixes

### Universal

* [Security and FileVault](/universal/security.md)
* For those who care about security and privacy.
* [Fixing Audio](/universal/audio.md)
* For those needing help resolving audio issues.
* [Booting without USB](/universal/oc2hdd.md)
* Allowing you to boot OpenCore without the USB installed.
* [Updating OpenCore, kexts and macOS](/universal/update.md)
* How to update your kexts, OpenCore and even macOS safely.
* [Fixing DRM](/universal/drm.md)
* For those with DRM issues like Netflix playback.
* [Fixing iServices](/universal/iservices.md)
* Help to fix misc iServices issues like iMessage.
* [Fixing Power Management](/universal/pm.md)
* Fixes and helps improve both hardware idle and boosting states.
* [Fixing USB](https://dortania.github.io/USB-Map-Guide/)
* Fixes for USB issues like missing ports and helping with sleep.

### Laptop Specifics

* [Fixing Battery Read-outs](/laptop-specific/battery.md)
* If your battery isn't supported out of the box with SMCBatteryManager.

### Cosmetics

* [Add GUI and Boot-chime](/cosmetic/gui.md)
* Add a fancy GUI to OpenCore and even a boot chime!
* [Fixing Resolution and Verbose](/cosmetic/verbose.md)
* Helps fix the resolution of OpenCore, and allows you to get that sweet Apple logo while booting!

### Multiboot

* [Setting up Bootstrap.efi](/multiboot/bootstrap.md)
* Ensures Windows doesn't remove OpenCore from our system.
* [Installing BootCamp](/multiboot/bootcamp.md)
* Allows us to install Bootcamp for easy boot switching.

### Miscellaneous

* [Fixing RTC](/misc/rtc.md)
* Helps resolve RTC/CMOS/safe-mode reboot issues.
* [Fixing CFG Lock](/misc/msr-lock.md)
* Allows use to remove some kernel patches for better stability
* [Emulated NVRAM](/misc/nvram.md)
* For users who have broken NVRAm, or need to test it.

https://dortania.github.io/OpenCore-Post-Install/
34 changes: 34 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Table of contents

* [OpenCore Post-Install](README.md)

## Universal

* [Security and FileVault](/universal/security.md)
* [Fixing Audio](/universal/audio.md)
* [Booting without USB](/universal/oc2hdd.md)
* [Updating OpenCore, kexts and macOS](/universal/update.md)
* [Fixing DRM](/universal/drm.md)
* [Fixing iServices](/universal/iservices.md)
* [Fixing Power Management](/universal/pm.md)
* [Fixing USB](https://dortania.github.io/USB-Map-Guide/)

## Laptop Specifics

* [Fixing Battery Read-outs](/laptop-specific/battery.md)

## Cosmetics

* [Add GUI and Boot-chime](/cosmetic/gui.md)
* [Fixing Resolution and Verbose](/cosmetic/verbose.md)

## Multiboot

* [Setting up Bootstrap.efi](/multiboot/bootstrap.md)
* [Installing BootCamp](/multiboot/bootcamp.md)

## Miscellaneous

* [Fixing RTC](/misc/rtc.md)
* [Fixing CFG Lock](/misc/msr-lock.md)
* [Emulated NVRAM](/misc/nvram.md)
57 changes: 57 additions & 0 deletions book.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"plugins": ["theme-default", "-lunr", "-search", "search-plus", "addcssjs", "favicon-plus", "anchor-navigation-ex", "github-buttons", "last-modified", "medium-zoom"],
"pluginsConfig": {
"fontsettings": {
"theme": "night",
"family": "sans"
},
"anchor-navigation-ex": {
"multipleH1": false
},
"github-buttons": {
"buttons": [{
"user": "dortania",
"repo": "OpenCore-Desktop-Guide",
"type": "star",
"size": "large"
}]
},
"intopic-toc": {
"label": "Navigation"
},
"github-edit": {
"repo": "dortania/Opencore-Desktop-Guide",
"branch": "master"
},
"favicon": "/icons/favicon.ico",
"appleTouchIconPrecomposed152": "/icons/appleTouchIconPrecomposed152.png",
"output": "_book"
},
"links": {
"sharing": {
"google": false,
"facebook": false,
"twitter": false,
"weibo": false,
"all": false
}
},
"medium-zoom": {
"margin": 24,
"background": "#363b40",
"scrollOffset": 0
},
"pdf": {
"pageNumbers": false,
"fontSize": 12,
"paperSize": "a4",
"margin": {
"right": 62,
"left": 62,
"top": 36,
"bottom": 36
},
"headerTemplate": null,
"footerTemplate": null
}
}
119 changes: 119 additions & 0 deletions cosmetic/gui.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# OpenCore beauty treatment

* Supported version: 0.5.9

Main thing this guide will go over:

* [Giving OpenCore a GUI](/extras/gui.md#giving-opencore-a-gui)
* [Setting up a boot-chime](/extras/gui.md#setting-up-a-boot-chime)

## Setting up OpenCore's GUI

So to get started, we're gonna need 0.5.7 or newer as these builds have the GUI included with the rest of the files. If you're on an older version, I recommend updating: [Updating OpenCore](/post-install/update.md)

Once that's done, we'll need a couple things:

* [Binary Resources](https://github.com/acidanthera/OcBinaryData)
* [OpenCanopy.efi](https://github.com/acidanthera/OpenCorePkg/releases)
* Note: OpenCanopy.efi must be from the same build as your OpenCore files, as mismatched files can cause boot issues

Once you have both of these, we'll next want to add it to our EFI partition:

* Add the [Resources folder](https://github.com/acidanthera/OcBinaryData) to EFI/OC
* Add OpenCanopy.efi to EFI/OC/Drivers

![](/images/extras/gui-md/folder-gui.png)

Now in our config.plist, we have 2 things we need to fix:

* `Misc -> Boot -> PickerMode`: `External`
* `Misc -> Boot -> PickerAttributes`:`1`
* This enables .VolumeIcon.icns reading off the drive, this is how macOS installer icons work
* 0x0008: This is another value which allows for alternative icons, such as the legacy GUI found on legacy Macs. This can be combined with `1` for both legacy GUI and custom drive icons(PickerAttributes: `9`)
* Other settings for PickerAttributes can be found in the [Configuration.pdf](https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/Configuration.pdf)
* `UEFI -> Drivers` and add OpenCanopy.efi

Once all this is saved, you can reboot and be greeted with a true Mac-like GUI:

![Credit to vit9696](/images/extras/gui-md/gui.png)

## Setting up Boot-chime with AudioDxe

So to start, we'll need a couple things:

* Onboard audio output
* USB DACs will not work
* GPU audio out is a hit or miss
* [AudioDxe](https://github.com/acidanthera/OpenCorePkg/releases) in both EFI/OC/Drivers and UEFI -> Drivers
* [Binary Resources](https://github.com/acidanthera/OcBinaryData)
* Add the Resources folder to EFI/OC, just like we did with the OpenCore GUI section
* For those running out of space, `OCEFIAudio_VoiceOver_Boot.wav` is all that's required for the Boot-Chime
* Debug version of OpenCore with logging enabled
* See [OpenCore Debugging](/troubleshooting/debug.md) for more info

**Settings up NVRAM**:

* NVRAM -> Add -> 7C436110-AB2A-4BBB-A880-FE41995C9F82:
* `SystemAudioVolume | Data | 0x46`
* This is the boot-chime and screen reader volume, note it's in hexadecimal so would become `70` in decimal

**Setting up UEFI -> Audio:**

* **AudioCodec:**
* Codec address of Audio controller
* To find yours:
* Check [IORegistryExplorer](https://github.com/toleda/audio_ALCInjection/blob/master/IORegistryExplorer_v2.1.zip) -> HDEF -> AppleHDAController -> IOHDACodecDevice and see the `IOHDACodecAddress` property
* ex: `0x0`
* Can also check via terminal(Note if multiple show up, use the vendor ID to find the right device)l:

```text
ioreg -rxn IOHDACodecDevice | grep VendorID // List all possible devices
```

```text
ioreg -rxn IOHDACodecDevice | grep IOHDACodecAddress // Grab the codec address
```

* **Audio Device:**
* PciRoot of audio controller
* Run [gfxutil](https://github.com/acidanthera/gfxutil/releases) to find the path:
* `/path/to/gfxutil -f HDEF`
* ex: `PciRoot(0x0)/Pci(0x1f,0x3)`

* **AudioOut:**
* The specific output of your Audio controller, easiest way to find the right one is to go through each one(from 0 to N - 1)
* ex: `2`
* You can find all the ones for your codec in the OpenCore debug logs:

```text
06:065 00:004 OCAU: Matching PciRoot(0x0)/Pci(0x1F,0x3)/VenMsg(A9003FEB-D806-41DB-A491-5405FEEF46C3,00000000)...
06:070 00:005 OCAU: 1/2 PciRoot(0x0)/Pci(0x1F,0x3)/VenMsg(A9003FEB-D806-41DB-A491-5405FEEF46C3,00000000) (5 outputs) - Success
```

* **AudioSupport:**
* Set this to `True`

* **MinimumVolume:**
* Volume level from `0` to `100`
* To not blow the speakers, set it to `70`
* Note boot-chime will not play if MinimumVolume is higher than `SystemAudioVolume` that we set back in the `NVRAM` section

* **PlayChime:**
* Set this to `True`

* **VolumeAmplifier:**
* The Volume amplification, value will differ depending on your codec
* Formula is as follows:
* (SystemAudioVolume * VolumeAmplifier)/100 = Raw Volume(but cannot exceed 100)
* ex: (`70` x `VolumeAmplifier`)/`100` = `100` -> (`100` x `100`) / `70` = VolumeAmplifier = `142.9`(we'll round it to `143` for simplicity)

Once done, you should get something like this:

![](/images/extras/gui-md/audio-config.png)

**Note for visually impaired**:

* OpenCore hasn't forgotten about you! With the AudioDxe setup, you can enable both picker audio and FileVault VoiceOver with these 2 settings:
* `Misc -> Boot -> PickerAudioAssist -> True` to enable picker audio
* `UEFI -> ProtocolOverrides -> AppleAudio -> True` to enable FileVault voice over
* See [Security and FileVault](/post-install/security.md) on how to setup the rest for proper FileVault support
53 changes: 53 additions & 0 deletions cosmetic/verbose.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Fixing Resolution and Verbose

* Supported version: 0.5.9

Wanting a more clean booting experience with macOS without all that verbose text while booting? Well you need a couple things:

<extoc></extoc>

## macOS Decluttering

**`Misc -> Debug`**

* Set `AppleDebug` to False, this will remove boot.efi debugging right at the start of booting.

**`NVRAM -> Add -> 7C436110-AB2A-4BBB-A880-FE41995C9F82`**:

* Remove `-v` from boot-args in your config.plist

**`NVRAM -> Add -> 4D1EDE05-38C7-4A6A-9CC6-4BCCA8B38C14`**:

* UIScale
* `01`: Standard resolution
* `02`: HiDPI (generally required for FileVault to function correctly on smaller displays)

**`UEFI -> Output`**:

* `TextRenderer` set to`BuiltinGraphics`
* `Resolution`: set to `Max` for best results
* Optionally can specify resolution: `WxH@Bpp (e.g. 1920x1080@32) or WxH (e.g. 1920x1080)`
* `ProvideConsoleGop` set to True

If still having issues, see [Configuration.pdf](https://github.com/acidanthera/OpenCorePkg/blob/master/Docs/Configuration.pdf) for all possible options.

## OpenCore Decluttering

So if you followed closely to this guide during install, you'll likely be running the debug version of OpenCore and a .txt file would be created on each boot. For those who want to remove OpenCore's extra debugging messages and that .txt file generation, see below:

**Inside your config.plist**:

* `Misc -> Debug -> Target`: 3
* `Target` is what determines both what is logged and how, see [OpenCore Debugging](/troubleshooting/debug.md) for more values

**Inside your EFI**:

* Replace the following files with the [release versions](https://github.com/acidanthera/OpenCorePkg/releases)(if previously using DEBUG versions):
* EFI/BOOT/
* `BOOTx64.efi`
* EFI/OC/Bootstrap/
* `Bootstrap.efi`
* EFI/OC/Drivers/
* `OpenRuntime.efi`
* EFI/OC/
* `OpenCore.efi`
Binary file added images/extras/gpu-patches-md/path-done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/gpu-patches-md/prereq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/gui-md/audio-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/gui-md/folder-gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/gui-md/gui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/kaslr-fix-md/mmio-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/legacy-md/boot-disk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/legacy-md/boot-done.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/legacy-md/download.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/legacy-md/efi-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/legacy-md/run-boot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/msr-lock-md/cfg-find.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/msr-lock-md/uefi-tool.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/spoof-md/config-gpu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/extras/spoof-md/corp-windows.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/audio-md/gfxutil-hdef.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/audio-md/hdef.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/audio-md/hex-convert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/audio-md/right-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/audio-md/wrong-layout.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/drm-md/dgpu-path.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/drm-md/igpu-frequency.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/drm-md/igpu-path.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/drm-md/vda.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/post-install/iservices-md/blacklist.png
Binary file added images/post-install/iservices-md/config-rom.png
Binary file added images/post-install/iservices-md/find-en0.png
Binary file added images/post-install/iservices-md/no-purchase.png
Binary file added images/post-install/iservices-md/not-valid.png
Binary file added images/post-install/iservices-md/serial-list.png
Binary file added images/post-install/iservices-md/valid.png
Binary file added images/post-install/nvram-md/nvram.png
Binary file added images/post-install/oc2hdd-md/hdd-clean.png
Binary file added images/post-install/oc2hdd-md/hdd-mount.png
Binary file added images/post-install/oc2hdd-md/usb-mount.png
Binary file added images/post-install/pm-md/X86PlatformShim.png
Binary file added images/post-install/pm-md/agpm.png
Binary file added images/post-install/pm-md/done.png
Binary file added images/post-install/pm-md/epp.png
Binary file added images/post-install/pm-md/files.png
Binary file added images/post-install/pm-md/lpm.png
Binary file added images/post-install/pm-md/macbook.png
Binary file added images/post-install/pm-md/pm-not-working.png
Binary file added images/post-install/pm-md/pm-working.png
Binary file added images/post-install/pm-md/prgen-done.png
Binary file added images/post-install/pm-md/prgen-run.png
Binary file added images/post-install/rtc-md/cmos-error.png
Binary file added images/post-install/rtc-md/rtc-blacklist.png
Binary file added images/post-install/security-md/sign-demo.png
Binary file added images/post-install/security-md/sign.png
Binary file added images/post-install/update-md/usb-erase.png
Binary file added images/post-install/update-md/usb-folder.png
Binary file added images/post-install/usb-md/255.png
Binary file added images/post-install/usb-md/build-map.png
Binary file added images/post-install/usb-md/deviceproperties.png
Binary file added images/post-install/usb-md/mapping.png
Binary file added images/post-install/usb-md/remove-rename.png
Binary file added images/post-install/usb-md/restart-fix.png
Binary file added images/post-install/usb-md/usb-3.png
Binary file added images/post-install/usb-md/usb-done.png
Binary file added images/post-install/usb-md/usb-map-start.png
Binary file added images/post-install/usb-md/usbw.png
Binary file added images/post-install/usb-md/xhci-path.png
Binary file added images/win-md/blessoverride.png
Loading

0 comments on commit c7e4c80

Please sign in to comment.