https://github.com/cwxiaos/bark-worker

Bark Server on Cloudflare Worker
https://github.com/cwxiaos/bark-worker

bark bark-server cloudflare cloudflare-workers

Last synced: about 2 months ago
JSON representation

Bark Server on Cloudflare Worker

• Host: GitHub
• URL: https://github.com/cwxiaos/bark-worker
• Owner: cwxiaos
• License: gpl-3.0
• Created: 2023-10-24T00:51:45.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-02-28T08:23:09.000Z (2 months ago)
• Last Synced: 2025-02-28T15:17:50.223Z (2 months ago)
• Topics: bark, bark-server, cloudflare, cloudflare-workers
• Language: JavaScript
• Homepage:
• Size: 3.01 MB
• Stars: 156
• Watchers: 2
• Forks: 112
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    
Bark-Worker


[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

English | **[中文文档](README.zh.md)**

> [!NOTE]

> Device token may change, the previous way to use multi-key or key alias may be unavailable, refer to [Tips](doc/tips.md) for more details.

> [!NOTE]

> Batch Push has the highest priority, if `device_keys` is specified and not empty, `device_key` will be ignored, in both V1 and V2 APIs.

Bark-Worker is a [Bark-Server](https://github.com/Finb/bark-server) implenmention on Cloudflare Worker. It provides privacy-aware users with a cheap and private bark backend. 

### What is [Bark](https://github.com/Finb/Bark)?

[Bark](https://github.com/Finb/Bark) is an iOS App which allows you to push customed notifications to your iPhone.

> [!NOTE]

> A domain is required if worker.dev is unavailable in your country/region

## Features

- Full Bark-Server APIs support

    - `register`

    - `ping`

    - `healthz`

    - `info`

    - `push`

- Path based parameters resolve

- Easy to deploy, Cheap to use and Convenient to manage

## Setup

> [!NOTE]

> Select one, D1 or KV Version are both available. D1 Version is recommended for its higher usage than KV Version

### Follow the instructions for D1 Version

[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/cwxiaos/bark-worker)

> [!NOTE]

> The Cloudflare API Token must have D1 permission.

### Or manually deploy

Refer to [Setup Guide](doc/setup_guide.md)

#### Cloudflare D1 Version

Or Manually Deploy

Create a Worker and a D1 Database, bind D1 database to Worker with name `database`

#### Cloudflare KV Version

Create a Worker and a KV Storage, bind KV Storage to Worker with name `database`

## Tips

- Multi Device Key to one Device

- Device Key Alias

- D1 Database Manage in Console

- etc.

Refer to [Tips](doc/tips.md)