diff --git a/Notify_nextcloud.md b/Notify_nextcloud.md new file mode 100644 index 0000000..bb2c692 --- /dev/null +++ b/Notify_nextcloud.md @@ -0,0 +1,69 @@ +## Nextcloud Notifications +* **Source**: https://nextcloud.com +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: 4000 Characters per message + +### Account Setup +TODO + +### Syntax +Secure connections (via https) should be referenced using **nclouds://** where as insecure connections (via http) should be referenced via **ncloud://**. + +Valid syntaxes are as follows: +* `ncloud://{hostname}/{notify_user}` +* `ncloud://{hostname}:{port}/{notify_user}` +* `ncloud://{admin_user}:{password}@{hostname}/{notify_user}` +* `ncloud://{admin_user}:{password}@{hostname}:{port}/{notify_user}` +* `nclouds://{hostname}/{notify_user}` +* `nclouds://{hostname}:{port}/{notify_user}` +* `nclouds://{admin_user}:{password}@{hostname}/{notify_user}` +* `nclouds://{admin_user}:{password}@{hostname}:{port}/{notify_user}` + +You can notify more then one user by simply chaining them at the end of the URL. +* `ncloud://{admin_user}:{password}@{hostname}:{port}/{notify_user1}/{notify_user2}/{notify_userN}` +* `nclouds://{admin_user}:{password}@{hostname}:{port}/{notify_user1}/{notify_user2}/{notify_userN}` + + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| hostname | Yes | The hostname of the server hosting your Nextcloud service. +| admin_user | Yes | The administration user of the next cloud service you have set up. +| password | Yes | The administrator password associated with the **admin_user** for your Nextcloud account. +| notify_user | Yes | One or more users you wish to send your notification to. +| to | No | This is an alias to the notify_user variable. + +#### Example +Send a secure nextcloud notification to the user _chucknorris_: +```bash +# Assuming our {host} is localhost +# Assuming our {admin_user} is admin +# Assuming our (admin) {password} is secret: +apprise nclouds://admin:secret@localhost/chucknorris +``` + +### Header Manipulation +Some users may require special HTTP headers to be present when they post their data to their server. This can be accomplished by just sticking a hyphen (**-**) in front of any parameter you specify on your URL string. +```bash +# Below would set the header: +# X-Token: abcdefg +# +# We want to send an insecure connection (we'll use ncloud://) +# Assuming our {host} is localhost +# Assuming our {admin_user} is admin +# Assuming our (admin) {password} is secret: +# We want to notify arnold +apprise ncloud://admin:secret@localhost/arnold?-X-Token=abcdefg + +# Multiple headers just require more entries defined with a hyphen in front: +# Below would set the headers: +# X-Token: abcdefg +# X-Apprise: is great +# +# Assuming our {host} is localhost +# Assuming our {admin_user} is admin +# Assuming our (admin) {password} is secret: +# We want to notify arnold +apprise ncloud://admin:secret@localhost/arnold?-X-Token=abcdefg&-X-Apprise=is%20great +``` \ No newline at end of file