TinyPush

flags

flag	default	description
addr		Address (e.g. 0.0.0.0:3002)
db_path		Database path
test		Test mode

go run main.go --addr=<Addr> --db_path=<dbPath># or
./tiny-push --addr=<Addr> --db_path=<dbPath>

init

• Start service

  📌TinyPush
  input the sub (e.g. `mailto:your@example.com`)
  -> mailto:your@example.com #<- input the email
  ⌛Drop tables
  ⌛Create tables
  ⌛Insert settings
  🎉Success!
  

• *replace push.nest.moe with your own domain <- self deploy

more...

• uuid will expire 90 days after last use
• It is not necessary to use uuid when providing endpoint, p256dh and auth directly

API

• GET /api/vapid

  • method: GET
  • response:

    {
    "code": 200,
    "message": "OK",
    "data": {
    "vapid": "<string>"
    },
    "version": "push"
    }

• POST /api/subscribe/

  • method: POST
  • Content-Type: application/x-www-form-urlencoded
  • body:
    • endpoint: <string>
    • p256dh: <string>
    • auth: <string>
  • response:

    // success
    {
    "code": 200,
    "message": "OK",
    "data": {
    "uuid": "<string>"
    },
    "version": "push"
    }
    // failed/// `uuid` here is unused
    { "code": 401, "message": "Invalid p256dh/auth/endpoint", "data": { "uuid": "<string>" }, "version": "push" }
    { "code": 500, "message": "Failed to generate uuid", "data": { "uuid": "<string>" }, "version": "push" }

• DELETE /api/subscribe/:uuid

  • method: DELETE
  • Content-Type: application/x-www-form-urlencoded
  • response:

    { "code": 200, "message": "OK", "data": true, "version": "push" }

• POST /api/push/:uuid?

  • method: POST

  • Content-Type: application/x-www-form-urlencoded

  • body:

    • endpoint?: <string>
    • p256dh?: <string>
    • auth?: <string>
    • test?: 1 || undefined
    • encoding?: aes128gcm || aesgcm
    • message: <string>

  • response:

    /// code === data.status// success
    {
    "code": 201,
    "message": "OK",
    "data": {
    "status": 201,
    "text": "<string>"
    },
    "version": "push"
    }
    // failed/// `code !== 201`/// https://web.dev/articles/push-notifications-common-issues-and-reporting-bugs

  • ext:

    • endpoint/p256dh/auth > uuid
    • when test=1, message in body can be empty, we will push a test message:

      This is a test content🔔✅🎉😺
      Fri Apr 26 2024 10:36:06 GMT+0800 (China Standard Time) (1714098966547)