Revise README for clarity and installation guidance

Updated the README to clarify the purpose of iGotify and its integration with Gotify and Apple's APNs. Improved installation instructions and feature descriptions.

Author: nicedevil007

README.md

@@ -4,288 +4,77 @@
 
 # iGotify
 
-A small Gotify server notification assistent that decrypt the message and trigger a Push Notifications to iOS Devices via Apple's APNs with my service SecNtfy
+A notification assistant that bridges [Gotify](https://gotify.net/) with iOS devices via Apple's APNs using the SecNtfy service.
 
-Download Link to iGotify down below
+> **Important:** This project is **not** Gotify itself. iGotify is a companion service that enables push notifications for iOS devices. The notification payload is only forwarded through SecNtfy to Apple's APNs - **no message content is stored** on any intermediate server.
 
- 
+## Features
 
-## ⭐ Features
+- End-to-end encrypted push notifications
+- Seamless Gotify integration
+- Native iOS app with FaceID support
+- Multi-user & multi-instance support
 
-* show received notifications with markdown
-* decrypted the message with a public key that is generated from the iGotify device
-* sending the decrypted message to SecNtfy and forwarded it to Apple's APN service, without saving the payload
-* multiuser support
+## Installation
 
- 
+There are two ways to deploy iGotify:
 
-## 🔧 How to Install Gotify & iGotify-Notification-Assist
+### Option 1: Docker (Recommended)
 
-### 🐳 Docker `docker-compose.yaml`
+The Docker stack includes both Gotify and iGotify.
 
-### Installation
-
-1. Create a file with the name `docker-compose.yaml` or clone this repo and go to step 3
-2. Please use the latest and recommended version of docker and docker compose
-3. Copy the code down below in the yaml file
-4. change environment variables in the compose file
-5. execute `docker compose up -d` to start the docker compose
-
- 
-
-### Needed environment variables
-
-* `GOTIFY_DEFAULTUSER_PASS` = the user password for the defaultuser
-
-### Optional environment variables
-
-* `GOTIFY_URLS` = the local gotify sever URL e.g.: `http://gotify`
-* `GOTIFY_CLIENT_TOKENS` = the client token from the Gotify Client e.g.: `cXXXXXXXX`
-* `SECNTFY_TOKENS` = the SecNtfy Token that you get from the app after configure it e.g.: `NTFY-DEVICE-XXXXXX`
-
-*These three environment variables above aren't required when the Gotify & iGotify Instances available over a domain!*
-
-* `ENABLE_CONSOLE_LOG` = you can disable unnecessary console logs (default: true)
-* `ENABLE_SCALAR_UI` = you can now disable the Endpoint page (default: true)
-
-*please write the boolean variables (true, false) in single quotes 'true'*
-
-#### All these configuration can be found after configure the app. It will display it for you
-
-#### Please note you can configure multiple instances of local gotify server by adding a semicolon `;` after each environment value e.g.:
-
-* `GOTIFY_URLS: 'http://gotify;http://gotify2;http://gotify3;...'`
-* `GOTIFY_CLIENT_TOKENS: 'cXXXXXXXX1;cXXXXXXXX2;cXXXXXXXX3;...'`
-* `SECNTFY_TOKENS: 'NTFY-DEVICE-XXXXXX1;NTFY-DEVICE-XXXXXX2;NTFY-DEVICE-XXXXXX3;...'`
-
- 
-
-### Docker Compose Konfigurationen
-
-<details>
-<summary><b>📦 Standard Docker Compose</b></summary>
-
-```yaml
-services:
-  gotify:
-    container_name: gotify
-    hostname: gotify
-    image: gotify/server          # Uncommand correct server image
-    # image: gotify/server-arm7
-    # image: gotify/server-arm64
-    restart: unless-stopped
-    security_opt:
-      - no-new-privileges:true
-    networks:
-      - net
-    ports:
-      - "8680:80"
-    volumes:
-      - data:/app/data
-    environment:
-      GOTIFY_DEFAULTUSER_PASS:  'my-very-strong-password'   # Change me!!!!!
-    healthcheck:
-      test: ["CMD-SHELL", "ls /app/data || exit 1"]
-      interval: 5s
-      timeout: 3s
-      retries: 5
-      start_period: 10s
-
-  igotify:
-    container_name: igotify
-    hostname: igotify
-    image: ghcr.io/androidseb25/igotify-notification-assist:latest
-    restart: unless-stopped
-    security_opt:
-      - no-new-privileges:true
-    pull_policy: always
-    depends_on:
-      gotify:
-        condition: service_healthy
-    healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:8080/Version" ]
-      interval: "3s"
-      timeout: "3s"
-      retries: 5
-    networks:
-      - net
-    ports:
-      - "8681:8080"
-    volumes:
-      - api-data:/app/data
-    #environment:                 # option environment see above note
-    # GOTIFY_URLS: ''
-    # GOTIFY_CLIENT_TOKENS: ''
-    # SECNTFY_TOKENS: ''
-    # ENABLE_CONSOLE_LOG: 'true'
-    # ENABLE_SCALAR_UI: 'true'
-
-networks:
-  net:
-
-volumes:
-  data:
-  api-data:
-```
-
-*Thank you The_Think3r for the compose file and @herrpandora*
-
-</details>
-
-<details>
-<summary><b>🔀 Traefik Config</b></summary>
-
-```yaml
-services:
-  gotify:
-    container_name: gotify
-    hostname: gotify
-    image: gotify/server          # Uncommand correct server image
-    # image: gotify/server-arm7
-    # image: gotify/server-arm64
-    restart: unless-stopped
-    security_opt:
-      - no-new-privileges:true
-    networks:
-      - net
-    ports:
-      - "8680:80"
-    volumes:
-      - data:/app/data
-    environment:
-      GOTIFY_DEFAULTUSER_PASS:  'my-very-strong-password'   # Change me!!!!!
-      GOTIFY_REGISTRATION:      'false'
-    labels:
-      traefik.docker.network: proxy
-      traefik.enable: "true"
-      traefik.http.routers.gotify-secure.entrypoints: websecure
-      traefik.http.routers.gotify-secure.middlewares: default@file
-      traefik.http.routers.gotify-secure.rule: Host(`gotify.domain-name.de`)
-      traefik.http.routers.gotify-secure.service: gotify
-      traefik.http.routers.gotify-secure.tls: "true"
-      traefik.http.routers.gotify-secure.tls.certresolver: http_resolver
-      traefik.http.routers.gotify.entrypoints: web
-      traefik.http.routers.gotify.rule: Host(`gotify.domain-name.de`)
-      traefik.http.services.gotify.loadbalancer.server.port: "80"
-    healthcheck:
-      test: ["CMD-SHELL", "ls /app/data || exit 1"]
-      interval: 5s
-      timeout: 3s
-      retries: 5
-      start_period: 10s
-    networks:
-      default: null
-      proxy: null
+```bash
+# Clone the repository
+git clone https://github.com/androidseb25/iGotify-Notification-Assistent.git
+cd iGotify-Notification-Assistent
 
-  igotify:
-    container_name: igotify
-    hostname: igotify
-    image: ghcr.io/androidseb25/igotify-notification-assist:latest
-    restart: unless-stopped
-    security_opt:
-      - no-new-privileges:true
-    pull_policy: always
-    depends_on:
-      gotify:
-        condition: service_healthy
-    healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:8080/Version" ]
-      interval: "3s"
-      timeout: "3s"
-      retries: 5
-    networks:
-      - net
-    ports:
-      - "8681:8080"
-    volumes:
-      - api-data:/app/data      
-    #environment:                 # option environment see above note
-    #  GOTIFY_URLS:          ''
-    #  GOTIFY_CLIENT_TOKENS: ''
-    #  SECNTFY_TOKENS:       ''    
-    labels:
-      traefik.docker.network: proxy
-      traefik.enable: "true"
-      traefik.http.routers.igotify-secure.entrypoints: websecure
-      traefik.http.routers.igotify-secure.middlewares: default@file
-      traefik.http.routers.igotify-secure.rule: Host(`igotify.domain-name.de`)
-      traefik.http.routers.igotify-secure.service: igotify
-      traefik.http.routers.igotify-secure.tls: "true"
-      traefik.http.routers.igotify-secure.tls.certresolver: http_resolver
-      traefik.http.routers.igotify.entrypoints: web
-      traefik.http.routers.igotify.rule: Host(`igotify.domain-name.de`)
-      traefik.http.services.igotify.loadbalancer.server.port: "8080"
-    networks:
-      default: null
-      proxy: null
+# Configure environment
+cp .env.example .env
+# Edit .env and set GOTIFY_DEFAULTUSER_PASS
 
-networks:
-  default:
-  proxy:
-    external: true
-volumes:
-  data:
-  api-data:
+# Start the stack
+docker compose up -d
 ```
 
-*Thank you to @majo1989 for sharing this config*
-
-</details>
-
-&nbsp;
-
-### (Optional) NGINX Proxy Manager
-
-When someone have problem's with incoming notifications on the app, please try this options under Advance Settings for the setuped proxies
+### Option 2: Linux Service
 
 ```bash
-proxy_set_header   Host $http_host;
-proxy_connect_timeout   1m;
-proxy_send_timeout      1m;
-proxy_read_timeout      1m;
+curl -sSL https://raw.githubusercontent.com/androidseb25/iGotify-Notification-Assistent/main/install.sh | bash
 ```
 
-Also **don't** check the boxes which say "HTTP/2 Support" and "HSTS enabled".
-
-*Thank you to @TBT-TBT for sharing this notice*
-
-&nbsp;
-
-## 🔧 Install iGotify app
-
-Download from [AppStore](https://apps.apple.com/de/app/igotify/id6473452512?itsct=apps_box_badge&amp;itscg=30200)
+### Default Ports
 
-[![Download on the App Store](https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/de-de?size=350&amp;releaseDate=1702425600)](https://apps.apple.com/de/app/igotify/id6473452512?itsct=apps_box_badge&amp;itscg=30200)
+| Service | Port |
+|---------|------|
+| Gotify  | 8680 |
+| iGotify | 8681 |
 
-For Bugs or feedback please send me a PM in Discord under the name sebakaderangler or fill out the issue formular here on GitHub.
+## Documentation
 
-On the login screen you need to enter the Gotify Server URL and the URL from the Notification Assist, if you use the URL with a port please enter it, too! (Image 1)
+For detailed documentation, visit the **[Wiki](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki)**:
 
-After the checks for the URL are finished and correct you need to login with your login credentials. (Image 2)
+- [How it works](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki#how-it-works) - Architecture and token explanation
+- [Docker Installation](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki#docker) - Full Docker setup with environment variables
+- [Linux Service](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki#linux-service) - Native installation guide
+- [Reverse Proxy](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki#reverse-proxy) - NGINX Proxy Manager configuration
+- [Roadmap](https://github.com/androidseb25/iGotify-Notification-Assistent/wiki#roadmap) - Planned features
 
-&nbsp;
+## iOS App
 
-![](https://raw.githubusercontent.com/androidseb25/iGotify-Notification-Assistent/main/login_screen_1.png)
-![](https://raw.githubusercontent.com/androidseb25/iGotify-Notification-Assistent/main/login_screen_2.png)
+[![Download on the App Store](https://tools.applemediaservices.com/api/badges/download-on-the-app-store/black/en-us?size=250&releaseDate=1702425600)](https://apps.apple.com/app/igotify/id6473452512)
 
-&nbsp;
- 
-And if everythink is ok, you're logged in 🎉
+## Bugs & Feedback
 
-Now you receive background notifications when Gotify receives a message.
+For bugs or feedback please send me a PM in Discord under the name [**sebakaderangler**](https://discord.com/users/432049343802114048) or fill out the [issue form](https://github.com/androidseb25/iGotify-Notification-Assistent/issues) here on GitHub.
 
-## Translation
-
-If you want to be a part of the translation team please create a issue:
-
-**Title: Translation: *language***
+## SecNtfy Status
 
-**Description: crowdin username and why you would be a part of the translation team**
+[Service Status](https://ipv64.net/status/secntfy)
 
-maybe you've been invited soon
+## Contributing
 
-The link to the crowdin project: [https://de.crowdin.com/project/igotify](https://de.crowdin.com/project/igotify)
+See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
 
-## SecNtfy Status
+## License
 
-Here you can find the online status of the service [Status](https://ipv64.net/status/secntfy)
+[MIT License](LICENSE)