summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJanito Vaqueiro Ferreira Filho <janito@mullvad.net>2019-07-18 11:54:09 +0000
committerJanito Vaqueiro Ferreira Filho <janito@mullvad.net>2019-07-18 17:13:55 +0000
commitd1632fd044054542cbb4b65928f9a14f3a51dcd2 (patch)
tree16b938a024f1aba6523baa1dd8df2088c32205f0
parentfb4f85392ff7c65d748ad1082aadd5187f779722 (diff)
downloadmullvadvpn-d1632fd044054542cbb4b65928f9a14f3a51dcd2.tar.xz
mullvadvpn-d1632fd044054542cbb4b65928f9a14f3a51dcd2.zip
Update README to describe how to set up keystore
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 82121baf75..42f9134ed7 100644
--- a/README.md
+++ b/README.md
@@ -156,6 +156,27 @@ ar = "/opt/android/android-ndk-r20/toolchains/llvm/prebuilt/linux-x86_64/bin/i68
linker = "/opt/android/android-ndk-r20/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android21-clang"
```
+#### Signing the release APK
+
+In order to build release APKs, they need to be signed. First, a signing key must be generated and
+stored in a keystore file. In the example below, the keystore file will be
+`/home/user/app-keys.jks` and will contain a key called `release`.
+
+```
+keytool -genkey -v -keystore /home/user/app-keys.jks -alias release -keyalg RSA -keysize 4096 -validity 10000
+```
+
+Fill in the requested information to generate the key and the keystore file. Suppose the file was
+protected by a password `keystore-password` and the key with a password `key-password`. This
+information should then be added to the `android/keystore.properties` file:
+
+```
+keyAlias = release
+keyPassword = key-password
+storeFile = /home/user/app-keys.jks
+storePassword = keystore-password
+```
+
### All platforms
1. Get the latest **stable** Rust toolchain via [rustup.rs](https://rustup.rs/).