diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/build.osx.rst | 75 | ||||
| -rw-r--r-- | docs/debug.rst | 22 |
2 files changed, 57 insertions, 40 deletions
diff --git a/docs/build.osx.rst b/docs/build.osx.rst index 48836a7..7e145a5 100644 --- a/docs/build.osx.rst +++ b/docs/build.osx.rst @@ -1,7 +1,22 @@ osx build ============= -sign the release +Cheat-sheet +------------------ + +tl;dr: + +.. code:: bash + export RELEASE=yes + export OSXAPPPASS=my-apple-app-pass + make clean && make vendor && make build + make installer + make sign_installer + make notarize_installer + make notarize_staple + make create_dmg + +Sign the release ------------------- in recent osx releases, it's not ok to just sign the insallers anymore. you @@ -12,11 +27,10 @@ integration of this process in the more or less official Qt tools (QTIFW). First, we build the regular installer (use RELEASE=yes to do a codesign step with macqtdeploy, note that this increases build time considerably): -``` -make build -RELEASE=yes make installer -make sign_installer -``` +.. code:: bash + make build + RELEASE=yes make installer + make sign_installer Now we export the app-specific password and we proceed to notarization. If you don't know what is this pass, you can create one in your Apple developer @@ -36,40 +50,37 @@ reference to a keychain item, as shown in the previous example. This assumes the keychain holds a keychain item named AC_PASSWORD with an account value matching the username AC_USERNAME. -``` -export OSXAPPPASS=my-apple-app-pass -make notarize_installer -``` +.. code:: bash + + export OSXAPPPASS=my-apple-app-pass + make notarize_installer Between the output of the last command, you will get a Request UUID. You should pass that request uid in the appropriate environment variable to check the status of the notarization process. Obviously, since the recent changes in Apple policies, you need to be in posession of a valid membership -``` -altool[5281:91963] No errors uploading 'build/installer/RiseupVPN-installer-0.20.4-175-gee4eb90.zip'. -RequestUUID = fe9a4324-bdcb-4c52-b857-f089dc904695 - -OSXMORDORUID=fe9a4324-bdcb-4c52-b857-f089dc904695 make notarize_check -xcrun altool --notarization-info fe9a4324-bdcb-4c52-b857-f089dc904695 -u "info@leap.se" -p my-apple-app-pass -2020-12-11 22:21:59.940 altool[5787:96428] No errors getting notarization info. - - RequestUUID: fe9a4324-bdcb-4c52-b857-f089dc904695 - Date: 2020-12-11 21:13:10 +0000 - Status: success - LogFileURL: https://osxapps-ssl.itunes.apple.com/itunes-assets/Enigma114/v4/0f/c9/1e/0fc91e64-2c9f-74e5-3cf6-96b8f3bf7170/developer_log.json?accessKey=1607916119_6680812212684569509_nLlPw6tYxTSiWZfFTb0atP9zZ3CEGDfW0btWV51xhjWHiCFqBt%2BneXd5Vp40eQCSx8e1W5PYCIe2db7JGbhoTeJsYxl7UmYssRvYpTxYJl8z90uwB9jkbS1fsd7niaAn%2BQs7xHdv%2BB9jaKQI8LJ%2BwYY8RPq1QaeCJxBIdeG44DY%3D - Status Code: 0 -Status Message: Package Approved -``` +.. code:: bash + altool[5281:91963] No errors uploading 'build/installer/RiseupVPN-installer-0.20.4-175-gee4eb90.zip'. + RequestUUID = fe9a4324-bdcb-4c52-b857-f089dc904695 + + OSXMORDORUID=fe9a4324-bdcb-4c52-b857-f089dc904695 make notarize_check + xcrun altool --notarization-info fe9a4324-bdcb-4c52-b857-f089dc904695 -u "info@leap.se" -p my-apple-app-pass + 2020-12-11 22:21:59.940 altool[5787:96428] No errors getting notarization info. + + RequestUUID: fe9a4324-bdcb-4c52-b857-f089dc904695 + Date: 2020-12-11 21:13:10 +0000 + Status: success + LogFileURL: https://osxapps-ssl.itunes.apple.com/itunes-assets/Enigma114/v4/0f/c9/1e/0fc91e64-2c9f-74e5-3cf6-96b8f3bf7170/developer_log.json?accessKey=1607916119_6680812212684569509_nLlPw6tYxTSiWZfFTb0atP9zZ3CEGDfW0btWV51xhjWHiCFqBt%2BneXd5Vp40eQCSx8e1W5PYCIe2db7JGbhoTeJsYxl7UmYssRvYpTxYJl8z90uwB9jkbS1fsd7niaAn%2BQs7xHdv%2BB9jaKQI8LJ%2BwYY8RPq1QaeCJxBIdeG44DY%3D + Status Code: 0 + Status Message: Package Approved If everything is ok, now you can finish the process, stapling the notarization info and creating the dmg. -``` -make notarize_staple -make create_dmg -``` +.. code:: bash + make notarize_staple + make create_dmg If everything went well, you should have a .dmg for your release under the `deploy` folder. -``` -created: /Users/admin/leap/bitmask-vpn/deploy/RiseupVPN-0.20.4-175-gee4eb90.dmg -``` +.. code:: bash + created: /Users/admin/leap/bitmask-vpn/deploy/RiseupVPN-0.20.4-175-gee4eb90.dmg diff --git a/docs/debug.rst b/docs/debug.rst index c746cf6..c9daba6 100644 --- a/docs/debug.rst +++ b/docs/debug.rst @@ -12,24 +12,29 @@ stop the privileged helper. First, see if the helper is running: -pgrep bitmask-helper +.. code::bash + pgrep bitmask-helper To stop it: -sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist +.. code::bash + sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist To start it: -sudo launchctl load /Library/LaunchDaemons/se.leap.bitmask-helper.plist -sudo launchctl start /Library/LaunchDaemons/se.leap.bitmask-helper.plist +.. code::bash + sudo launchctl load /Library/LaunchDaemons/se.leap.bitmask-helper.plist + sudo launchctl start /Library/LaunchDaemons/se.leap.bitmask-helper.plist Check that it's running: -pgrep bitmask-helper +.. code::bash + pgrep bitmask-helper Manually check that the web api is running, and that it reports a version that matches what you currently have installed: -curl http://localhost:7171/version +.. code::bash + curl http://localhost:7171/version Also, you can check that the path near the end of the file /Library/LaunchDaemons/se.leap.bitmask-helper.plist matches the current path where you installed RiseupVPN.app. @@ -38,8 +43,9 @@ Cleaning up ~~~~~~~~~~~ If you have things messed up and you want to completely delete the bitmask-helper: -sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist -sudo rm -rf /Library/LaunchDaemons/se.leap.bitmask-helper.plist +.. code::bash + sudo launchctl unload /Library/LaunchDaemons/se.leap.bitmask-helper.plist + sudo rm -rf /Library/LaunchDaemons/se.leap.bitmask-helper.plist Make sure that "pgrep bitmask-helper" does not return any pid. |