nextcloud-desktop/admin/osx/mac-crafter/README.md
Camila Ayres 6acdee0813 Add README about mac-crafter.
Signed-off-by: Camila Ayres <hello@camilasan.com>
2024-10-08 14:32:37 +02:00

2.3 KiB

mac-crafter

A tool to easily build a fully-functional Nextcloud Desktop Client for macOS.

It will create the application bundle with the option to sign it, which is required by Apple when running and debugging the file provider module.

System requirements

  • Mac OS > 11
  • XCode
  • Python

Step by step usage

  1. Clone the desktop client in your mac OS
https://github.com/nextcloud/desktop.git
  1. Create the build folder
mkdir <build folder>
  1. Build the desktop client:
swift run --build-path <build folder> --package-path <cloned desktop repo>/admin/osx/mac-crafter mac-crafter <cloned desktop repo>

3.1 Sign the application bundle by adding the following parameter: -c "Apple Development: <certificate common name>" The whole command will look like this:

swift run --build-path <build folder> --package-path <cloned desktop repo>/admin/osx/mac-crafter mac-crafter <cloned desktop repo> -c "Apple Development: <certificate common name>"

Tip

Check Apple's oficial documentation about code signing.

3.2 Build the file provider module with this option:

--build-file-provider-module

3.3 Disable the auto-updater:

--disable-autoupdater

3.4 Set the architecture you are building for:

--arch arm64

The options are x86_64 and arm64.

How to build the app bundle for arm and intel

To achieve this we are using KDE Craft.

  1. After running the steps above, you will be able to use the CraftMaster.py script for that:
python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --add-blueprint-repository https://github.com/nextcloud/desktop-client-blueprints/

The --target options are define in the craftmaster.ini file.

  1. Install the client dependencies
python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --install-deps nextcloud-client
  1. Build the client
python build/craftmaster/CraftMaster.py --config <cloned desktop repo>/craftmaster.ini --target macos-clang-arm64 -c --src-dir <cloned desktop repo> nextcloud-client