Giter Club home page Giter Club logo

ntfy-android-builder's Introduction

ntfy Android Builder

A builder for the ntfy Android app that makes it easier to build a release for your custom server! No local setup required, everything is built using GitHub Actions.

Note: This builder only supports building the Play release with Firebase Cloud Messaging.

Preparation

  1. Create a Firebase project and add an Android app, using io.heckel.ntfy as package ID when asked. Save the google-services.json.
  2. Generate a new keystore using keytool if you don't have one already:
keytool -genkey -v -keystore your_keystore_name.keystore -alias your_alias_name -keyalg RSA -keysize 2048 -validity 10000

Make sure to save the password somewhere. 3. Fork this repository. You might want to consider making it private to hide your custom artifact builds.

Setting up

  1. Enable GitHub actions for your repository (if disabled!)
  2. Create a base64-encoded copy of your previously generated keystore: cat your_keystore_name.keystore | base64
  3. In Actions secrets, set the following:
    1. APK_KEYSTORE: The base64-encoded copy of your keystore generated in step 2.
    2. APK_KEYSTORE_PASS: The password to your keystore to be used for signing.
    3. NTFY_APP_BASE_URL: Default server base URL to be used in the app.
    4. NTFY_FCM_CONFIG: Contents of the Firebase Cloud Messaging config file, as downloaded in step 1 of Preparation.
  4. Go the the GitHub actions tab, run the Android CI workflow and wait for a few minutes
  5. Done! Your signed APK can be found in the list of artifacts.

Getting help

If you need help with ntfy in particular, please contact them directly. I am not affilated with them in any way.

I am not planning on providing extensive support for this little project. Feel free to open an issue if you need help, but don't expect me to fix all of your problems.

Pull requests to enhance the workflow are of course always welcome!

ntfy-android-builder's People

Contributors

ahmedhaies avatar binwiederhier avatar comradekingu avatar doits avatar eskilop avatar felix2yu avatar florosgithubbo avatar gergepalfi avatar hdtestis avatar kusoneko avatar lifehome avatar linerly avatar malmeloo avatar nathanaelhoun avatar oersen avatar opossumpetya avatar poipoipoipoipoipoipoipoipoi avatar rhld16 avatar rogeliodh avatar rubenelshof avatar rubenixnagios avatar stanol avatar stoyandimitrov avatar tha14 avatar tmpod avatar vkopitsa avatar waclaw66 avatar weblate avatar wunter8 avatar yjsoft avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.