kadu/gotify-android-client
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Compare commits

base: kadu:afcf93087c47cb4a6bc64445bcba3956f5b67662
Branches Tags
kadu:master
...
compare: kadu:master
Branches Tags
kadu:master

1 Commits
afcf93087c ... master

Author SHA1 Message Date
kdusek
9b2cdc7786 Update README.md with customization details
Some checks failed
Build / Check (push) Failing after 1m33s
Details
2025-11-28 20:07:34 +01:00
1 changed files with 15 additions and 27 deletions
Expand all files Collapse all files

42
README.md
View File

@@ -1,47 +1,44 @@
# Gotify Android [![Build Status][github-action-badge]][github-action] [![FOSSA Status][fossa-badge]][fossa] [![latest release version][release-badge]][release] [![F-Droid][fdroid-badge]][fdroid] # Gotify Custom Android
<img align="right" src="app.gif" width="250" /> <img align="right" src="app.gif" width="250" />
Gotify Android connects to [gotify/server](https://github.com/gotify/server) and shows push notifications on new messages. Gotify Custom Android is a customized version of the Gotify Android client that connects to [gotify/server](https://github.com/gotify/server) and shows push notifications on new messages.
## Features ## Features
* show push notifications on new messages * show push notifications on new messages
* view and delete messages * view and delete messages
* filter notifications by priority (custom feature)
## Installation ## Installation
Download the apk or get the app via F-Droid or Google Play. Build the APK using the instructions below or download from the releases.
[<img src="https://play.google.com/intl/en_gb/badges/images/generic/en_badge_web_generic.png" alt="Get it on Google Play" width="150" />][playstore] This is a custom build with package name `com.github.gotifycustom` to avoid conflicts with the original Gotify app.
[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" alt="Get it on F-Droid" width="150"/>][fdroid]
[<img src="download-badge.png" alt="Get it on F-Droid" width="150"/>][release]
Google Play and the Google Play logo are trademarks of Google LLC.
### Disable battery optimization ### Disable battery optimization
By default Android kills long running apps as they drain the battery. With enabled battery optimization, Gotify will be killed and you wont receive any notifications. By default Android kills long running apps as they drain the battery. With enabled battery optimization, Gotify Custom will be killed and you wont receive any notifications.
Here is one way to disable battery optimization for Gotify. Here is one way to disable battery optimization for Gotify Custom.
* Open "Settings" * Open "Settings"
* Search for "Battery Optimization" * Search for "Battery Optimization"
* Find "Gotify" and disable battery optimization * Find "Gotify Custom" and disable battery optimization
See also https://dontkillmyapp.com for phone manufacturer specific instructions to disable battery optimizations. See also https://dontkillmyapp.com for phone manufacturer specific instructions to disable battery optimizations.
### Minimize the Gotify foreground notification ### Minimize the Gotify Custom foreground notification
*Only possible for Android version >= 8* *Only possible for Android version >= 8*
The foreground notification showing the connection status can be manually minimized to be less intrusive: The foreground notification showing the connection status can be manually minimized to be less intrusive:
* Open Settings -> Apps -> Gotify * Open Settings -> Apps -> Gotify Custom
* Click Notifications * Click Notifications
* Click on `Gotify foreground notification` * Click on `Gotify Custom foreground notification`
* Toggle the "Minimize" option / Select a different "Behavior" or "Importance" (depends on your Android version) * Toggle the "Minimize" option / Select a different "Behavior" or "Importance" (depends on your Android version)
* Restart Gotify * Restart Gotify Custom
## Message Priorities ## Message Priorities
@@ -60,6 +57,8 @@ Use Java 17 and execute the following command to build the apk.
$ ./gradlew build $ ./gradlew build
``` ```
The APK will be in `app/build/outputs/apk/` with package name `com.github.gotifycustom`.
## Update client ## Update client
* Run `./gradlew generateSwaggerCode` * Run `./gradlew generateSwaggerCode`
@@ -70,19 +69,8 @@ $ ./gradlew build
* Commit changes * Commit changes
## Versioning ## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the We use [SemVer](http://semver.org/) for versioning.
[tags on this repository](https://github.com/gotify/android/tags).
## License ## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
[github-action-badge]: https://github.com/gotify/android/workflows/Build/badge.svg
[github-action]: https://github.com/gotify/android/actions?query=workflow%3ABuild
[playstore]: https://play.google.com/store/apps/details?id=com.github.gotify
[fdroid-badge]: https://img.shields.io/f-droid/v/com.github.gotify.svg
[fdroid]: https://f-droid.org/de/packages/com.github.gotify/
[fossa-badge]: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgotify%2Fandroid.svg?type=shield
[fossa]: https://app.fossa.io/projects/git%2Bgithub.com%2Fgotify%2Fandroid
[release-badge]: https://img.shields.io/github/release/gotify/android.svg
[release]: https://github.com/gotify/android/releases/latest