edited readme
This commit is contained in:
32
README.md
32
README.md
@ -1,26 +1,30 @@
|
||||
# Discord Testflight Programs watcher
|
||||
# Testflight Programs watcher with Discord webhook notifications
|
||||
Forked from https://github.com/alecs297/discord-testflight-watcher/tree/main
|
||||
|
||||
Very basic Node.js script that sends webhook data when a testflight link is available.
|
||||
|
||||
This script refreshes the invites every 30 seconds and doesn't require a discord bot account.
|
||||
|
||||
This repo is not maintained and the script itself was written in under one hour, feel free to enhance it on your own.
|
||||
|
||||
## Requirements
|
||||
|
||||
- node.js
|
||||
- npm
|
||||
- node-fetch
|
||||
|
||||
- Docker
|
||||
## Setup
|
||||
|
||||
- make sure to have a relatively recent version of node installed (too lazy / busy to check for the exact one)
|
||||
- install the dependencies via `npm install`
|
||||
- Copy the `settings.json.example` to `settings.json` and modify it to your needs. The ID of the testflight program corresponds to the last part of the invite ( `https://testflight.apple.com/join/XXXXXXXX` ), the URL field corresponds to the webhook URL.
|
||||
|
||||
## Usage
|
||||
|
||||
Once `settings.json` is changed, just use `node index.js` to execute the script. Something like PM2 is recommended if you want to let it run in the background.
|
||||
Exemple docker-compose file:
|
||||
```
|
||||
version: '3'
|
||||
services:
|
||||
testflight-watcher:
|
||||
image: uzurka/testflight-watcher
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
TESTFLIGHT_ID: KmtX0bcQ # Paste here what comes after the "https://testflight.apple.com/join/" in the beta link
|
||||
DISCORD_WEBHOOK_URL: https://discord.com/api/webhooks/123456789/FDSFSDFSDFSDFSDF # Paste here the URL of your Discord Webhook
|
||||
```
|
||||
Docker run command:
|
||||
```
|
||||
docker run --env TESTFLIGHT_ID= --env DISCORD_WEBHOOK_URL=h uzurka/testflight-watcher
|
||||
```
|
||||
|
||||
## Beta Programs
|
||||
|
||||
|
Reference in New Issue
Block a user