From 844197513461b824bf7d516c993b41b893c8cd8c Mon Sep 17 00:00:00 2001 From: Clovis Durand Date: Mon, 21 Jun 2021 14:32:11 +0200 Subject: [PATCH] Updated README.md with instructions about code signing Signed-off-by: Clovis Durand --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 291b6c38..7b78400f 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ npx cap sync With the Capacitor plugin installed, configure your app to use it via the following steps: -1. Add your deployment keys to the `capacitor.config.json` file, making sure to include the right key: +1. Add your deployment & code signing (optional) keys to the `capacitor.config.json` file, making sure to include the right key: ```json "Plugins": { @@ -65,7 +65,16 @@ With the Capacitor plugin installed, configure your app to use it via the follow } ``` - As a reminder, these keys are generated for you when you created your CodePush app via the CLI. If you need to retrieve them, you can simply run `appcenter codepush deployment list --app / --displayKeys`, and grab the key for the specific deployment you want to use (e.g. `Staging`, `Production`). App IDs can be retreived by running `appcenter apps list`. + As a reminder, the *deployment* keys are generated for you when you created your CodePush app via the CLI. If you need to retrieve them, you can simply run `appcenter codepush deployment list --app / --displayKeys`, and grab the key for the specific deployment you want to use (e.g. `Staging`, `Production`). App IDs can be retrieved by running `appcenter apps list`. + + The *public* keys should be generated by you, as should the corresponding private keys. + ```bash + # generate private RSA key and write it to private.pem file + openssl genrsa -out private.pem + + # export public key from private.pem into public.pem + openssl rsa -pubout -in private.pem -out public.pem + ``` *NOTE: You [must](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#releasing-updates) create a separate CodePush app for iOS and Android, which is why the above sample illustrates declaring separate keys for Android and iOS. If you're only developing for a single platform, then you only need to specify the deployment key for either Android or iOS.* @@ -156,7 +165,7 @@ The CodePush client supports differential updates, so even though you are releas *NOTE: for **Ionic** apps you need to run `ionic build` before running `release` command in order to build web assets.* -For more details about how the `release` command works, as well as the various parameters it exposes, refer to the [CLI docs](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#releasing-updates-general). +For more details about how the `release` command works, as well as the various parameters it exposes, refer to the [CLI docs](https://docs.microsoft.com/en-us/appcenter/distribution/codepush/cli#releasing-updates-general). If you run into any issues, or have any questions/comments/feedback, you can open a new issue on this repo and we'll respond ASAP!