PushDeer Documentation

To keep the core library focused, additional functionality is provided via separate component libraries:

• AlamofireImage: Includes image response serializers, UIImage and UIImageView extensions, custom image filters, an auto-purging in-memory cache, and a priority-based image downloading system.
• AlamofireNetworkActivityIndicator: Controls the visibility of the network activity indicator on iOS, featuring configurable delay timers to mitigate flicker and support for URLSession instances not managed by Alamofire.

gorush provides several advanced features for notification management:

• Multi-platform support: APNS, FCM, and HMS.
• Flexible Configuration: Supports YAML configuration.
• Scalability: Supports notification queues with multiple workers and various backends like NSQ, NATS, or Redis.
• Reliability: Supports retrying failed notifications and graceful shutdown.
• Observability: Exposes Prometheus metrics and system statistics via /sys/stats.
• Storage Options: App statistics can be stored in memory, Redis, BoltDB, BuntDB, LevelDB, or BadgerDB.
• Deployment: Ready for Docker, Kubernetes, and AWS Lambda.

PushDeer for Android is a client application designed to receive and manage push notifications. It supports features such as message lists, device/key management, and Markdown rendering.

Note: The official Android version may experience issues with interface permissions. The project is currently not actively maintained. For reliable service, it is recommended to use ServerChan³.

DeerESP is an extension of PushDeer for IOT, using ESP8266/ESP32 chips to push messages to smart devices via MQTT. There are four main ways to obtain the hardware:

1. Pre-assembled (Option 1): Fully assembled with a 3D-printed case (~60 RMB).
2. DIY Kit (Option 2): Unsoldered components with a 3D-printed case (~50 RMB).
3. Open Source PCB (Option 3): Self-printed PCB and components via open-source hardware designs (~25 RMB).
4. Basic Components (Option 4): Direct purchase of an 8266 development board, screen, and buzzer for manual wiring (~35 RMB).

Option 1 and 4 require no soldering, while 2 and 3 require soldering skills.

Alamofire can be installed using several dependency managers depending on your project setup:

• CocoaPods: Supported.
• Carthage: Supported.
• Swift Package Manager: Supported.
• Manual: Supported.

If you are using the self-hosted version of the iOS client, you must configure push certificates:

1. Navigate to the push directory.
2. Rename *.yml.sample files to *.yml.
3. Configure ios.yml for the main App and clip.yml for the Clip functionality.
4. Ensure the production value is set correctly based on your deployment state.
5. By default, the configuration expects c.p12 for the App certificate and cc.p12 for the Clip certificate.

Prerequisites

• Node.js environment (v16.13.1 recommended)
• Quick App IDE
• adb
• Quick App Debugger
• An Android device

Setup and Execution

1. Clone the source code.
2. Install dependencies:

cd quickapp && yarn

3. Launch the Quick App IDE and open the quickapp folder. The IDE will automatically compile and display the interface in the simulator.

gorush can run as a web server to handle incoming requests. It defaults to port 8088.

Start the server

Ensure a config.yml file exists before running.

# Start with default config
gorush

# Start with a custom config file
gorush -c config.yml

Check API server status

You can check the status of the API server using httpie:

http -v --verify=no --json GET http://localhost:8088/api/stat/go

# for default config
$ gorush
# for custom config file
$ gorush -c config.yml

To run a self-hosted instance of the PushDeer API, follow these steps:

1. Clone the repository:

   git clone https://github.com/easychen/pushdeer.git

2. Start the API using Docker: Run docker-compose up -d from the repository root. The API will be accessible at http://127.0.0.1:8800 by default. You can modify the port in the docker-compose.yml file.

Before starting the service, you must create a configuration directory and a configuration file at /etc/gorush/. You can use an existing configuration file as a template. Once configured, start the service using the init script.

mkdir -p /etc/gorush
cp config/testdata/config.yml /etc/gorush/

/etc/init.d/gorush start