From 32e77de8bba009928f30467af4d79f252e3ace17 Mon Sep 17 00:00:00 2001 From: Ali BARIN Date: Mon, 5 Dec 2022 00:52:13 +0100 Subject: [PATCH] docs(ntfy): describe actions and auth --- packages/docs/pages/.vitepress/config.js | 8 ++++++++ packages/docs/pages/apps/ntfy/actions.md | 12 ++++++++++++ packages/docs/pages/apps/ntfy/connection.md | 10 ++++++++++ packages/docs/pages/public/favicons/ntfy.svg | 1 + 4 files changed, 31 insertions(+) create mode 100644 packages/docs/pages/apps/ntfy/actions.md create mode 100644 packages/docs/pages/apps/ntfy/connection.md create mode 100644 packages/docs/pages/public/favicons/ntfy.svg diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index 912ef91b..5e207ea5 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -69,6 +69,14 @@ export default defineConfig({ { text: 'Connection', link: '/apps/github/connection' }, ], }, + { + text: 'Ntfy', + collapsible: true, + items: [ + { text: 'Actions', link: '/apps/ntfy/actions' }, + { text: 'Connection', link: '/apps/ntfy/connection' }, + ], + }, { text: 'RSS', collapsible: true, diff --git a/packages/docs/pages/apps/ntfy/actions.md b/packages/docs/pages/apps/ntfy/actions.md new file mode 100644 index 00000000..efc1bfbc --- /dev/null +++ b/packages/docs/pages/apps/ntfy/actions.md @@ -0,0 +1,12 @@ +--- +favicon: /favicons/ntfy.svg +items: + - name: Send a message + desc: Sends a message to a topic you specify. +--- + + + + diff --git a/packages/docs/pages/apps/ntfy/connection.md b/packages/docs/pages/apps/ntfy/connection.md new file mode 100644 index 00000000..d2d81ac5 --- /dev/null +++ b/packages/docs/pages/apps/ntfy/connection.md @@ -0,0 +1,10 @@ +# Ntfy + +:::info +This page explains the steps you need to follow to set up the Ntfy +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +If you use ntfy.sh, the official public server for this service, you do not need to set up a connection with a custom configuration. It's enough to create one with the default server URL. + +However, if you have a ntfy installation, that's different than ntfy.sh, you need to specify your server URL on Automatisch while creating a connection. Additionally, you may need to provide your username and password if your installation requires authentication. diff --git a/packages/docs/pages/public/favicons/ntfy.svg b/packages/docs/pages/public/favicons/ntfy.svg new file mode 100644 index 00000000..9e5b5136 --- /dev/null +++ b/packages/docs/pages/public/favicons/ntfy.svg @@ -0,0 +1 @@ + \ No newline at end of file