feat: reorganise for cloud content
Some checks failed
ci / build_and_publish (push) Failing after 1m15s

This commit is contained in:
Iain Learmonth 2026-02-23 19:09:21 +00:00
parent c7d058c599
commit a27970713e
27 changed files with 203 additions and 19 deletions

6
docs/account/index.md Normal file
View file

@ -0,0 +1,6 @@
---
sidebar_position: 10
---
# User Accounts

View file

@ -1,5 +1,5 @@
---
label: Background Topics
position: 30
position: 5
link:
type: "generated-index"

View file

@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 0
sidebar_label: Welcome
---

View file

@ -1,5 +0,0 @@
---
label: Admin Guide
position: 30
link:
type: "generated-index"

View file

@ -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:
<aside>
💡
You might need to wait up to one minute for the QR code to fully load (you initially will see a similar code as on the screenshot but when it loads it will have a lot more and smaller squares).
</aside>
![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

15
docs/link/admin/index.mdx Normal file
View file

@ -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.
:::
<DocCardList items={useCurrentSidebarCategory().items} />

View file

@ -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.
:::

View file

@ -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.
:::

View file

@ -1,5 +1,5 @@
---
sidebar_position: 1
sidebar_position: 20
sidebar_label: Link Helpdesk
---

View file

@ -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