gotify-firefox

Send push notifications to your Gotify server from Firefox
git clone git://fossdaily.xyz/gotify-firefox
Log | Files | Refs | README | LICENSE

README.md (3622B)


      1 # Gotify Firefox Add-on
      2 
      3 _Send push notifications to your Gotify server from Firefox._  
      4 _This is an evolving project of mine to replicate the functionality of Pushbullet using Gotify._
      5 
      6 
      7 * [Gotify Firefox Add-on](#Gotify-Firefox-Add-on)
      8   * [Installation ⚡ī¸](#Installation-%E2%9A%A1%EF%B8%8F)
      9   * [Sources 🔗](#Sources-%F0%9F%94%97)
     10   * [Gotify for Android 📱](#Gotify-for-Android-%F0%9F%93%B1)
     11     * [Use Termux to create a text message or send a link from the Android share menu to your Gotify server](#Use-Termux-to-create-a-text-message-or-send-a-link-from-the-Android-share-menu-to-your-Gotify-server)
     12   * [Gotify for Linux đŸ’ģ](#Gotify-for-Linux-%F0%9F%92%BB)
     13   * [Notes 📃](#Notes-%F0%9F%93%83)
     14   * [Screenshots 📷](#Screenshots-%F0%9F%93%B7)
     15     * [**Right-click menu**](#Right-click-menu)
     16     * [**Menu popup**](#Menu-popup)
     17     * [**Settings**](#Settings)
     18   * [Development 🔩](#Development-%F0%9F%94%A9)
     19 
     20 ## Installation ⚡ī¸
     21 
     22 1. First you will need to install the Gotify server, which you can get from [here](https://gotify.net/).
     23 
     24 2. Next you will want to install the signed add-on from the Mozilla Firefox website. ([License](LICENSE))
     25 
     26     **[![Get it for Firefox!](https://addons.cdn.mozilla.net/static/img/addons-buttons/AMO-button_1.png)](https://addons.mozilla.org/en-US/firefox/addon/gotify-for-firefox/?src=external-gitea-download)**
     27 
     28 3. Finally open the Gotify for Firefox settings page and input your **Gotify server url** and the **application token**.
     29 
     30     > You can generate a new application token on your Gotify server's web-page, on the **APPS** page. Remember to keep your token private.
     31 
     32 4. Done.
     33 
     34 ## Sources 🔗
     35 
     36 * The **Gotify for Firefox add-on** is a fork of the **Gotify Chrome Extension**, source-code of which is available [here](https://github.com/rorpage/gotify-chrome).
     37 
     38 * Big thanks to https://notabug.org/crimeflare for modifying the code to work with Firefox. **I highly recommend** that people check out [The Great Cloudwall](https://notabug.org/crimeflare/cloudflare-tor/src/master/README.md) by crimeflare.
     39  
     40 * **Gotify Server:** https://github.com/gotify/server
     41 * **Gotify Android App:** https://github.com/gotify/android
     42 
     43 ## Gotify for Android 📱
     44 
     45 * Gotify for Android is available on [F-Droid](https://f-droid.org/en/packages/com.github.gotify/), [APK download](https://github.com/gotify/android/releases/latest) or you can get it from [Google Play](https://play.google.com/store/apps/details?id=com.github.gotify).
     46 
     47 ## Notes 📃
     48 
     49 * Your welcome to leave a feature request or an issue report, but please keep in mind that this is a fun little project that I will work on in my spare time. Contributions can be made by creating a Pull Request. If you would like to donate, please consider donating to the [Free Software Foundation](https://my.fsf.org/donate).
     50 
     51 ## Screenshots 📷
     52 
     53 ### **Right-click menu**
     54 
     55 ![Right-click menu](images/menu.png)
     56 
     57 ### **Menu popup**
     58 
     59 ![Menu popup](images/popout.png)
     60 
     61 ### **Settings**
     62 
     63 ![Settings](images/settings.png)
     64 
     65 ## Development 🔩
     66 
     67 * **Gotify Documentation:** https://gotify.net/docs/
     68 * **Gotify REST-API:** https://gotify.github.io/api-docs/
     69 
     70 1. Clone repository
     71 
     72 ```sh
     73 git clone https://git.fossdaily.xyz/caltlgin/gotify-firefox
     74 ```
     75 
     76 2. In the Firefox url bar type `about:debugging`
     77 3. Click `Load Temporary Add-on...`
     78 4. Navigate to the folder where you cloned the repository.
     79 5. Select the `manifest.json` file.
     80 6. The addon should now be installed.
     81 
     82 ---
     83 
     84 > Šī¸ [README.md](README.md) content licensed under [Creative Commons License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/)