Skip to content

Customizing the Name and Icon of the Android App

Jump to bottom
Martin Wahnschaffe edited this page Apr 30, 2021 · 2 revisions

This section is relevant for systems that are using the custom branding and also want to have the Android app customized.

Unfortunately it is not possible (and allowed) to change the name or icon of an Android app without adjusting the provided information and resources contained in the APK file. This means it is not possible to change both at runtime based on information provided by the backend (e.g. configures in sormas.properties), as we do for the SORMAS web application.

To workaround this a tool called APK EditorStudio can be used as follows:

  1. Download and run the latest version of the APK Editor Studio: https://github.com/kefir500/apk-editor-studio/releases
  2. Open the APK file you want to change. This will mostly be the sormas-app contained in the release version of SORMAS you are using: https://github.com/hzi-braunschweig/SORMAS-Project/releases On a SORMAS instance server you can find the file in the configured download directory (default is '''/var/www/sormas/downloads''').
  3. Use the tool to adjust the icon and the name translations as needed.
  4. Optional: Change to sormas_logo used in the login screen (see details below)
  5. **Make sure to set up a keystore that will be used to pack and sign the apk file. Details are explained below.
  6. Hit "Pack APK" to create the updated apk file.

Changing the login screen logo

  1. Browse the Resource in the bottom left of APK Editor Studio
  2. Extend the "drawable" resource and locate the sormas_logo.png
  3. Right-click each of the sormas_logo.png DPI children and replace the resource with the custom logo

Generate a key and keystore

If you don't already have a key and keystore for signing the app, please follow these steps:

  1. In the menu bar, click Tools > Key Manager.
  2. Select Custom KeyStore. Then hit the "Create" button
  3. Enter the needed information:
    • Password (KeyStore): Create and confirm a secure password for your KeyStore
    • Alias: Enter an identifying name for your key.
    • Password (Alias): Create and confirm a secure password for your key. This should be different from the password you chose for your keystore.
    • Validity (years): Set the length of time in years that your key will be valid. Your key should be valid for at least 25 years, so you can sign app updates with the same key through the lifespan of your app.
    • First and Last Name, ...: Enter some information about yourself for your certificate. This information is not displayed in your app, but is included in your certificate as part of the APK.
  4. Store the KeyStore file on your system. This file is extremely important so make sure to keep it in a save place!
  5. Back in the Key Manager, enter the information on KeyStore Key alias.
Clone this wiki locally