Skip to content

Commit

Permalink
Merge pull request shanyungyang#3 from kiler129/building-docs
Browse files Browse the repository at this point in the history
Add clarification about building
  • Loading branch information
shanyungyang authored Oct 22, 2020
2 parents 8e51460 + c940622 commit 3471623
Showing 1 changed file with 40 additions and 3 deletions.
43 changes: 40 additions & 3 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ maintain on ESXi.
2. Installation
---------------
Copy the distribution file to the ESXi host datastore using scp or some other
data transfer system.
data transfer system. If you want to use the source version (i.e. from GIT) see
"5. Building" fist.

Decompress the file from the ESXi console or via SSH:

Expand Down Expand Up @@ -64,7 +65,43 @@ Note: The uncompressed size reported for custom.vgz will vary depending on the E

B. The unlocker can be temporarily disabled during boot by editing the boot options and adding "nounlocker".

5. Thanks
5. Building
-----------
If you want to use a version which is not availbale as a distribution (e.g. the code from "master" branch)
you need to first build the package.

Checkout the repository:

git clone https://github.com/shanyungyang/esxi-unlocker.git

(if you don't have git installed you can download ZIP archive from GitHub instead)

Enter the directory and build:

cd esxi-unlocker
./esxi-build.py

If everything went correctly the ouput should be:

ESXi-Build for macOS

Timestamping files...

Creating unlocker.tgz...
etc/
etc/rc.local.d/
etc/rc.local.d/unlocker.py

Creating esxi-unlocker-301.tgz...
unlocker.tgz
esxi-install.sh
esxi-uninstall.sh
esxi-smctest.sh
readme.txt

The package you need to copy in the example above is esxi-unlocker-301.tgz (NOT unlocker.tgz!).

6. Thanks
---------

Thanks to Zenith432 for originally building the C++ unlocker and Mac Son of Knife
Expand All @@ -79,4 +116,4 @@ History
26/09/18 3.0.0 - First release
01/05/20 3.0.1 - Fix for ESXi 7.0

(c) 2011-2018 Dave Parsons
(c) 2011-2018 Dave Parsons

0 comments on commit 3471623

Please sign in to comment.