From 25ee6a47a094390ba7985256fa141cf86b10d8cc Mon Sep 17 00:00:00 2001 From: lead2gold Date: Mon, 25 Dec 2017 15:14:07 -0500 Subject: [PATCH] Updated Notify_pushjet (markdown) --- Notify_pushjet.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/Notify_pushjet.md b/Notify_pushjet.md index dab6bb2..c833b7a 100644 --- a/Notify_pushjet.md +++ b/Notify_pushjet.md @@ -5,23 +5,30 @@ * **Message Limit**: 32768 Characters per message ### Syntax -Valid syntax is as follows: -* **pjet**:://**{apikey}**@**{host}** -* **pjet**:://**{apikey}**@**{host}**:**{port}** -* **pjets**:://**{apikey}**@**{host}** -* **pjets**:://**{apikey}**@**{host}**:**{port}** +If you want to use your own custom Pushjecct server, then the following identify the syntax you may use: +* **pjet**:://**{secret_key}**@**{host}** +* **pjet**:://**{secret_key}**@**{host}**:**{port}** +* **pjets**:://**{secret_key}**@**{host}** +* **pjets**:://**{secret_key}**@**{host}**:**{port}** + +However, if you're using the Pushjet official server (and not your own, then you only need to provide the secret key: +* **pjet**:://**{secret_key}** ### Parameter Breakdown | Variable | Required | Description | ----------- | -------- | ----------- -| apikey | Yes | The API Key associated with your Pushjet account. -| host | Yes | The Pushjet server. -| port | No | The port Pushjet is listening on. By default the port is **80** for **pjet://** and **443** for all **pjets://** references. +| secret_key | Yes | The Secret Key associated with your Pushjet account. +| host | No | The Pushjet server is only required if you're hosting your own notification server yourself (and not using https://pushjet.io/) +| port | No | The Pushjet port optional and only required if you're hosting your own notification server. By default the port is **80** for **pjet://** and **443** for all **pjets://** references. #### Example Send a Pushjet notification: ```bash -# Assuming our {apikey} is abcdefghijklmnop-abcdefg +# Assuming our {secret_key} is abcdefghijklmnopqrstuvwxyzabc # Assuming our {hostname} is pushjet.server.local -notify pjet://abcdefghijklmnop-abcdefg@pushjet.server.local +notify pjet://abcdefghijklmnopqrstuvwxyzabc@pushjet.server.local + +# Alternatively if you're just using the pushjet.io server you might +# provide the following: +notify pjet://abcdefghijklmnopqrstuvwxyzabc ``` \ No newline at end of file