diff --git a/docs/account/index.md b/docs/account/index.md new file mode 100644 index 0000000..a817535 --- /dev/null +++ b/docs/account/index.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 10 +--- + +# User Accounts + diff --git a/docs/background/_category_.yml b/docs/background/_category_.yml index db09b3c..4f72b9a 100644 --- a/docs/background/_category_.yml +++ b/docs/background/_category_.yml @@ -1,5 +1,5 @@ --- label: Background Topics -position: 30 +position: 5 link: type: "generated-index" diff --git a/docs/index.md b/docs/index.md index a89ddc4..9cd0f25 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 0 sidebar_label: Welcome --- diff --git a/docs/link/admin/_category_.yml b/docs/link/admin/_category_.yml deleted file mode 100644 index fc2a715..0000000 --- a/docs/link/admin/_category_.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -label: Admin Guide -position: 30 -link: - type: "generated-index" diff --git a/docs/link/admin/e2e_channels.md b/docs/link/admin/e2e_channels.md new file mode 100644 index 0000000..d3e9ad2 --- /dev/null +++ b/docs/link/admin/e2e_channels.md @@ -0,0 +1,141 @@ +--- +label: E2E channels +sidebar_position: 50 +description: Setting up E2E channels (Signal and WhatsApp) +--- + +# End-to-end encrypted channels + +## Initial setup + +1. Log in to your CDR Link helpdesk admin panel using either ‘Sign in with Google button’ or Sign in with Zammad credentials’: + +![Untitled](/docs/link/admin/Untitled.png) + +1. Using the left side menu go to Admin → **WhatsApp** (or **Signal**): + +![Untitled](/docs/link/admin/d33b0fb2-d2e4-4130-9dfc-4e5e26ab2fad.png) + +1. Create the **WhatsApp** (or **Signal**) connection by using the blue ‘Create’ button in top right corner of the screen: + +![Untitled](/docs/link/admin/Untitled%201.png) + +You will see a pop-up window like the one below: + +- Fill the ‘Name’ field with some recognisable name (it can be useful to name it like ‘Signal handset 1’ in case if you are planning to use more numbers) of the channel +- Fill ‘Phone Number’ field with your handsets phone number containing the relevant country code. + +![Untitled](/docs/link/admin/Untitled%202.png) + +- Click ‘Save’. +1. You will see next window with QR code similar to the following: + + + + +![Untitled](/docs/link/admin/Untitled%203.png) + +- Copy the Token and save it in a safe place. +- Now you need to scan the code. Depending on which channel you are configuring you have to follow the instructions below (they may vary slightly depending on what kind of device you are using, in example we are using Android device): + - For **WhatsApp**: + - Go to main screen (screen with all chats visible). + - On the top right corner tap the ‘three dots’ icon. + - From the drop down menu tap on the ‘Linked devices’. + - Tap the green ‘Link a device’ button. + - Scan the code from your computers screen. + - For **Signal**: + - Go to the main screen (screen with all chats visible). + - On the top right corner tap the ‘three dots’ icon. + - From the drop down menu tap on the ‘Settings’. + - Tap on the ‘Linked devices’. + - Tap the blue ‘Link a device’ button. + - Scan the code from your computers screen. + - In both cases after scanning the code you should see your newly linked channel connection under the ‘Linked devices’ list of your WhatsApp/Signal communicator. +- You can press the blue ‘Done’ button on your connection screen. +1. Now you need to create a bot. Using the left side menu go to Admin → Zammad Settings → Channels → **WhatsApp** (or **Signal**): + +![Untitled](/docs/link/admin/Untitled%204.png) + +1. Create the **WhatsApp** (or **Signal)** bot by using the green ‘Add WhatsApp bot’ (or ‘Add Signal bot’) button in top right corner of the screen: + +![Untitled](/docs/link/admin/Untitled%205.png) + +You will see a pop up window like the one below: + +- Fill the ‘Phone Number’ field with same phone number as you used in point 3. +- Paste the bot token from point 4 into the ‘Bot Token’ field (in case if you lost it you can always come back to the admin and click on the previously created connection in order to retrieve the token. +- In ‘Bot Endpoint’ field paste: + - For **WhatsApp:** + + ```json + + http://link:3000/link/api/whatsapp + ``` + + - For **Signal**: + + ```json + + http://link:3000/link/api/signal + ``` + +- You can leave the ‘Users’ and ‘Organization’ fields as they are or pick the relevant values. + +![Untitled](/docs/link/admin/7e1319ba-5c17-4eae-8226-44bbae0f7e54.png) + +- Click the ‘Submit’ button. +- You will see your newly created bot on the list - click the ‘Edit’ button on the right side of the bot: + +![Untitled](/docs/link/admin/Untitled%206.png) + +- You will see the same form as previously but with one additional field: ‘Endpoint URL’ - copy the part after **https://your-helpdesk.cdr.link/api/v1/channels_cdr_whatsapp_webhook/** or **https://your-helpdesk.cdr.link/api/v1/channels_cdr_signal_webhook/** - make sure to copy all of it as it is a very long code as you can see in the example below: + +![Untitled](/docs/link/admin/Untitled%207.png) + +![Untitled](/docs/link/admin/Untitled%208.png) + +- Paste the code in the safe temporary place and click on the ‘Cancel & Go Back’ link on the left bottom corner of the form. +1. The last part is to create a Webhook. Go back to the Admin panel, select Admin → Webhooks: + +![Untitled](/docs/link/admin/Untitled%209.png) + +- Click the blue ‘Create’ button in top right corner: + +![Untitled](/docs/link/admin/Untitled%2010.png) + +- You will see a webhook creation form like the one below: + +![Untitled](/docs/link/admin/Untitled%2011.png) + +- In the ‘Name’ field type some name that is relating to the channel name and handset. +- The method drop down menu should be left with ‘Post’. +- In the ‘Endpoint’ field paste: + - For **WhatsApp**: + + ```text + http://zammad-nginx:8080/api/v1/channels_cdr_whatsapp_webhook/xxxxxxx + ``` + + `where ‘xxxxxx’ should be replaced with the code copied from ‘Endpoint URL’ from point 6` + + - For **Signal**: + + ```text + http://zammad-nginx:8080/api/v1/channels_cdr_signal_webhook/xxxxxxx + ``` + + `where ‘xxxxxx’ should be replaced with the code copied from ‘Endpoint URL’ from point 6` + +- Below there are two drop down menus: + - In the left one pick the relevant channel. + - In the right one pick the bot name that you created in step 3. +- Click the blue ‘Save’ button. + +🎉 Congrats! Your connection is ready! + +## Reconnection \ No newline at end of file diff --git a/docs/link/admin/index.mdx b/docs/link/admin/index.mdx new file mode 100644 index 0000000..a4bbcc9 --- /dev/null +++ b/docs/link/admin/index.mdx @@ -0,0 +1,15 @@ +--- +sidebar_label: Admin Guide +sidebar_position: 30 +--- + +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# Admin Guide + +:::warning[Under construction] +This documentation is a work in progress. Please [get in touch with us](mailto:contact@sr2.uk) if you have any questions. +::: + + \ No newline at end of file diff --git a/docs/link/admin/intro.md b/docs/link/admin/intro.md deleted file mode 100644 index e07d6bb..0000000 --- a/docs/link/admin/intro.md +++ /dev/null @@ -1,5 +0,0 @@ -# Introduction - -:::warning[Under construction] -This documentation is a work in progress. Please [get in touch with us](mailto:help@cdr.link) if you have any questions. -::: \ No newline at end of file diff --git a/docs/link/agent/intro.md b/docs/link/agent/intro.md index e07d6bb..a7775fa 100644 --- a/docs/link/agent/intro.md +++ b/docs/link/agent/intro.md @@ -1,5 +1,5 @@ # Introduction :::warning[Under construction] -This documentation is a work in progress. Please [get in touch with us](mailto:help@cdr.link) if you have any questions. +This documentation is a work in progress. Please [get in touch with us](mailto:contact@sr2.uk) if you have any questions. ::: \ No newline at end of file diff --git a/docs/link/index.mdx b/docs/link/index.mdx index d8c3667..bc4e29e 100644 --- a/docs/link/index.mdx +++ b/docs/link/index.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 20 sidebar_label: Link Helpdesk --- diff --git a/docs/mirrors/index.mdx b/docs/mirrors/index.mdx index 08343d2..d9156bc 100644 --- a/docs/mirrors/index.mdx +++ b/docs/mirrors/index.mdx @@ -1,6 +1,6 @@ --- title: Web Mirrors -sidebar_position: 20 +sidebar_position: 30 --- A web mirror can help users by providing alternate URLs to access censored resources, allowing them to bypass censorship diff --git a/docusaurus.config.js b/docusaurus.config.js index d0b8ef4..97a96bf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -122,21 +122,39 @@ const config = { ], }, { - title: '2nd Column', + title: 'Policy', items: [ + { + label: 'Terms and Conditions', + href: 'https://www.sr2.uk/terms', + }, + { + label: 'Privacy Policy', + href: 'https://www.sr2.uk/privacy', + }, + { + label: 'Complaints Policy', + href: 'https://www.sr2.uk/complaints', + } ], }, { title: 'More', items: [ { - label: 'Git', + label: 'SR2 Communications', + href: 'https://www.sr2.uk/', + }, + { + label: 'Open Source', href: 'https://guardianproject.dev/sr2/', }, ], }, ], - copyright: `Copyright © 2021-${new Date().getFullYear()} SR2 Communications Limited.
This documentation is made available to you under the terms of the Creative Commons Attribution 4.0 International licence.`, + copyright: ` + SR2 Cloud Documentation © 2021-${new Date().getFullYear()} is licensed under CC BY 4.0. +
SR2® and SR2 Communications® are registered trademarks of SR2 Communications Limited, a company registered in Scotland, number SC692687.` }, prism: { theme: prismThemes.github, diff --git a/src/pages/index.js b/src/pages/index.js index 9e8ae15..8edc87b 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -16,6 +16,19 @@ function HomepageHeader() { {siteConfig.title}

{siteConfig.tagline}

+
+ + Login to Console 🧑‍💻 + + + Read the Docs 📚 + +
+ ); @@ -26,7 +39,7 @@ export default function Home() { return ( + description="Cloud.">
diff --git a/src/pages/index.module.css b/src/pages/index.module.css index 7c22e45..820fffb 100644 --- a/src/pages/index.module.css +++ b/src/pages/index.module.css @@ -21,4 +21,5 @@ display: flex; align-items: center; justify-content: center; + gap: 1rem; } diff --git a/static/docs/link/admin/7e1319ba-5c17-4eae-8226-44bbae0f7e54.png b/static/docs/link/admin/7e1319ba-5c17-4eae-8226-44bbae0f7e54.png new file mode 100644 index 0000000..09684a5 Binary files /dev/null and b/static/docs/link/admin/7e1319ba-5c17-4eae-8226-44bbae0f7e54.png differ diff --git a/static/docs/link/admin/Untitled 1.png b/static/docs/link/admin/Untitled 1.png new file mode 100644 index 0000000..2712a3d Binary files /dev/null and b/static/docs/link/admin/Untitled 1.png differ diff --git a/static/docs/link/admin/Untitled 10.png b/static/docs/link/admin/Untitled 10.png new file mode 100644 index 0000000..70d7eb8 Binary files /dev/null and b/static/docs/link/admin/Untitled 10.png differ diff --git a/static/docs/link/admin/Untitled 11.png b/static/docs/link/admin/Untitled 11.png new file mode 100644 index 0000000..d1b5356 Binary files /dev/null and b/static/docs/link/admin/Untitled 11.png differ diff --git a/static/docs/link/admin/Untitled 2.png b/static/docs/link/admin/Untitled 2.png new file mode 100644 index 0000000..0b6fbca Binary files /dev/null and b/static/docs/link/admin/Untitled 2.png differ diff --git a/static/docs/link/admin/Untitled 3.png b/static/docs/link/admin/Untitled 3.png new file mode 100644 index 0000000..26af39f Binary files /dev/null and b/static/docs/link/admin/Untitled 3.png differ diff --git a/static/docs/link/admin/Untitled 4.png b/static/docs/link/admin/Untitled 4.png new file mode 100644 index 0000000..8ef9987 Binary files /dev/null and b/static/docs/link/admin/Untitled 4.png differ diff --git a/static/docs/link/admin/Untitled 5.png b/static/docs/link/admin/Untitled 5.png new file mode 100644 index 0000000..d2dfd19 Binary files /dev/null and b/static/docs/link/admin/Untitled 5.png differ diff --git a/static/docs/link/admin/Untitled 6.png b/static/docs/link/admin/Untitled 6.png new file mode 100644 index 0000000..dda98ca Binary files /dev/null and b/static/docs/link/admin/Untitled 6.png differ diff --git a/static/docs/link/admin/Untitled 7.png b/static/docs/link/admin/Untitled 7.png new file mode 100644 index 0000000..ee573e9 Binary files /dev/null and b/static/docs/link/admin/Untitled 7.png differ diff --git a/static/docs/link/admin/Untitled 8.png b/static/docs/link/admin/Untitled 8.png new file mode 100644 index 0000000..e955c1a Binary files /dev/null and b/static/docs/link/admin/Untitled 8.png differ diff --git a/static/docs/link/admin/Untitled 9.png b/static/docs/link/admin/Untitled 9.png new file mode 100644 index 0000000..ff27e41 Binary files /dev/null and b/static/docs/link/admin/Untitled 9.png differ diff --git a/static/docs/link/admin/Untitled.png b/static/docs/link/admin/Untitled.png new file mode 100644 index 0000000..7603ddd Binary files /dev/null and b/static/docs/link/admin/Untitled.png differ diff --git a/static/docs/link/admin/d33b0fb2-d2e4-4130-9dfc-4e5e26ab2fad.png b/static/docs/link/admin/d33b0fb2-d2e4-4130-9dfc-4e5e26ab2fad.png new file mode 100644 index 0000000..1bc206e Binary files /dev/null and b/static/docs/link/admin/d33b0fb2-d2e4-4130-9dfc-4e5e26ab2fad.png differ