paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-10-23 04:52:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

help: Add language and highlight markers.

Browse Source
This commit is contained in:
Alex Vandiver
2025-09-04 03:51:59 +00:00
committed by Tim Abbott
parent 968dfc5a28
commit 9fdeddb773
8 changed files with 49 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
starlight_help/src/content/docs/custom-certificates.mdx
View File

@@ -76,7 +76,7 @@ certificate store, like your web browser.
once the `nss` tools are installed, the command to trust the
certificate is:
```
```bash "path/to/certificate.pem"
certutil -d sql:$HOME/.pki/nssdb -A -t "P,," -n zulip \
-i path/to/certificate.pem
```

12
starlight_help/src/content/docs/desktop-app-install-guide.mdx
View File

@@ -76,7 +76,7 @@ releases](#install-a-beta-release).
<Steps>
1. Enter the following commands into a terminal:
```
```bash
sudo apt install curl
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
https://download.zulip.com/desktop/apt/zulip-desktop.asc
@@ -108,7 +108,7 @@ releases](#install-a-beta-release).
<Steps>
1. Make sure [snapd](https://docs.snapcraft.io/core/install) is installed.
1. Execute following command to install Zulip:
```
```bash
sudo snap install zulip
```
1. Run Zulip from your app launcher, or with `zulip` from a terminal.
@@ -121,12 +121,12 @@ releases](#install-a-beta-release).
system.
1. Use the following command from the official
[Flathub page](https://flathub.org/apps/org.zulip.Zulip) to install Zulip:
```
```bash
flatpak install flathub org.zulip.Zulip
```
1. After the installation is complete, you can run Zulip using the following
command:
```
```bash
flatpak run org.zulip.Zulip
```
</Steps>
@@ -163,7 +163,7 @@ Get a peek at new features before they're released!
<Steps>
1. Enter the following commands into a terminal:
```
```bash
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
https://download.zulip.com/desktop/apt/zulip-desktop.asc
echo "deb https://download.zulip.com/desktop/apt beta main" | \
@@ -180,7 +180,7 @@ Get a peek at new features before they're released!
<Steps>
1. Enter the following commands into a terminal:
```
```bash
sudo sed -i s/stable/beta/ /etc/apt/sources.list.d/zulip-desktop.list
sudo apt update
sudo apt install zulip

51
starlight_help/src/content/docs/import-from-mattermost.mdx
View File

@@ -45,27 +45,29 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
<TabItem label="Default installation">
<Steps>
1. SSH into your Mattermost production server.
```
```bash "<username>" "<server_ip>"
ssh <username>@<server_ip>
```
1. Navigate to the directory which contains the Mattermost executable.
On a default install of Mattermost, the directory is `/opt/mattermost/bin`.
```
```bash
cd /opt/mattermost/bin
```
1. Create an export of all your Mattermost teams, as a tar file.
```
```bash
sudo ./mattermost export bulk export.json --all-teams --attachments
mkdir -p exported_emoji
tar --transform 's|^|mattermost/|' -czf export.tar.gz \
data/ exported_emoji/ export.json
```
1. Exit your shell on the Mattermost server.
`exit`
```bash
exit
```
1. Finally, copy the exported tar file from the server to your local
computer. You may need to replace `/opt/mattermost/bin/` with the
path to your Mattermost installation.
```
```bash "<username>" "<server_ip>"
scp <username>@<server_ip>:/opt/mattermost/bin/export.tar.gz .
```
</Steps>
@@ -76,21 +78,21 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
1. Make sure you have [mmctl](https://github.com/mattermost/mmctl) installed - these
instructions assume your version is `7.5.1` or higher.
1. Log into your Mattermost Cloud instance using your administrator credentials.
```
```bash "yourdomain"
mmctl auth login https://yourdomain.cloud.mattermost.com
```
1. Create a full export of the server, including attached files.
```
```bash
mmctl export create
```
1. List all of the exports on the server, and copy the name of the
latest one to your clipboard.
```
```bash
mmctl export list
```
1. Download the export to your local computer, replacing
`latest_export` with the actual file name from the previous step.
```
```bash
mmctl export download latest_export.zip
```
</Steps>
@@ -99,16 +101,16 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
<TabItem label="Docker">
<Steps>
1. SSH into the server hosting your Mattermost docker container.
```
```bash "<username>" "<server_ip>"
ssh <username>@<server_ip>
```
1. Navigate to the Mattermost docker directory. On most installs, the
directory should be `mattermost-docker`.
```
```bash
cd mattermost-docker/
```
1. Create an export of all your Mattermost teams, as a tar file.
```
```bash
docker exec -it mattermost-docker_app_1 mattermost \
export bulk data/export.json --all-teams --attachments
cd volumes/app/mattermost/data/
@@ -117,11 +119,13 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
data/ exported_emoji/ export.json
```
1. Exit your shell on the Mattermost server.
`exit`
```bash
exit
```
1. Finally, copy the exported tar file from the server to your local
computer. You may need to replace `mattermost-docker` with the
appropriate path for your installation.
```
```bash "<username>" "<server_ip>"
scp <username>@<server_ip>:mattermost-docker/volumes/app/mattermost/data/export.tar.gz .
```
</Steps>
@@ -130,8 +134,11 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
<TabItem label="GitLab Omnibus">
<Steps>
1. SSH into your GitLab Omnibus server.
1. Create an export of all your Mattermost teams, as a tar file.
```bash "<username>" "<server_ip>"
ssh <username>@<server_ip>
```
1. Create an export of all your Mattermost teams, as a tar file.
```bash
cd /opt/gitlab/embedded/service/mattermost
sudo -u \
mattermost /opt/gitlab/embedded/bin/mattermost \
@@ -142,9 +149,11 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
data/ exported_emoji/ export.json
```
1. Exit your shell on the GitLab Omnibus server.
`exit`
1. Finally, copy the exported tar file from GitLab Omnibus to your local computer.
```bash
exit
```
1. Finally, copy the exported tar file from GitLab Omnibus to your local computer.
```bash "<username>" "<server_ip>"
scp <username>@<server_ip>:/opt/gitlab/embedded/bin/mattermost/export.tar.gz .
```
</Steps>
@@ -172,7 +181,7 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
(`EXTERNAL_HOST`) of the Zulip installation, run the following commands,
replacing `<team-name>` with the name of the Mattermost team you want to import.
<ImportSelfHostedServerTips />
```
```bash "<team-name>"
cd /tmp
tar -xf mattermost_data.tar.gz
cd /home/zulip/deployments/current
@@ -182,7 +191,7 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
./scripts/start-server
```
Alternatively, to import into a custom subdomain, run:
```
```bash "<team-name>" "<subdomain>"
cd /tmp
tar -xf mattermost_data.tar.gz
cd /home/zulip/deployments/current
@@ -207,7 +216,7 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
(`EXTERNAL_HOST`) of the Zulip installation, run the following commands,
replacing `<team-name>` with the name of the Mattermost team you want to import.
<ImportSelfHostedServerTips />
```
```bash "<team-name>"
unzip latest_export.zip -d /tmp/my_mattermost_export
mv /tmp/my_mattermost_export/import.jsonl /tmp/my_mattermost_export/export.json
cd /home/zulip/deployments/current
@@ -217,7 +226,7 @@ Replace `<username>` and `<server_ip>` with the appropriate values below.
./scripts/start-server
```
Alternatively, to import into a custom subdomain, run:
```
```bash "<team-name>" "<subdomain>"
unzip latest_export.zip -d /tmp/my_mattermost_export
mv /tmp/my_mattermost_export/import.jsonl /tmp/my_mattermost_export/export.json
cd /home/zulip/deployments/current

4
starlight_help/src/content/docs/import-from-rocketchat.mdx
View File

@@ -82,7 +82,7 @@ be your **exported data** file in the instructions below.
(`EXTERNAL_HOST`) of the Zulip installation, run the following
commands.
<ImportSelfHostedServerTips />
```
```bash
cd /home/zulip/deployments/current
./scripts/stop-server
./manage.py convert_rocketchat_data /tmp/rocketchat_data --output /tmp/converted_rocketchat_data
@@ -90,7 +90,7 @@ be your **exported data** file in the instructions below.
./scripts/start-server
```
Alternatively, to import into a custom subdomain, run:
```
```bash "<subdomain>"
cd /home/zulip/deployments/current
./scripts/stop-server
./manage.py convert_rocketchat_data /tmp/rocketchat_data --output /tmp/converted_rocketchat_data

4
starlight_help/src/content/docs/import-from-slack.mdx
View File

@@ -120,7 +120,7 @@ in order to export direct message data.
(`EXTERNAL_HOST`) of the Zulip installation, run the following
commands, replacing `<token>` with your Slack **Bot User OAuth Token**.
<ImportSelfHostedServerTips />
```
```bash "<token>"
cd /home/zulip/deployments/current
./scripts/stop-server
./manage.py convert_slack_data /tmp/slack_data.zip --token <token> --output /tmp/converted_slack_data
@@ -128,7 +128,7 @@ in order to export direct message data.
./scripts/start-server
```
Alternatively, to import into a custom subdomain, run:
```
```bash "<token>" "<subdomain>"
cd /home/zulip/deployments/current
./scripts/stop-server
./manage.py convert_slack_data /tmp/slack_data.zip --token <token> --output /tmp/converted_slack_data

10
starlight_help/src/content/docs/include/_ImportHowUsersWillLogIn.mdx
View File

@@ -38,12 +38,12 @@ If you imported your organization into Zulip Cloud, simply email
<Steps>
1. To test the process, start by sending yourself a password reset email by
using the following command:
```
```bash "username@example.com"
./manage.py send_password_reset_email -u username@example.com
```
1. When ready, send password reset emails to all users by
using the following command:
```
```bash
./manage.py send_password_reset_email -r '' --all-users
```
</Steps>
@@ -53,17 +53,17 @@ If you imported your organization into Zulip Cloud, simply email
<Steps>
1. To test the process, start by sending yourself a password reset email by
using the following command:
```
```bash "username@example.com"
./manage.py send_password_reset_email -u username@example.com
```
1. When ready, send password reset emails to all users by
using the following command:
```
```bash "<subdomain>"
./manage.py send_password_reset_email -r <subdomain> --all-users
```
If you would like to only send emails to users who have not logged in yet,
you can use the following variant instead:
```
```bash "<subdomain>"
./manage.py send_password_reset_email -r <subdomain> --all-users --only-never-logged-in
```
</Steps>

4
starlight_help/src/content/docs/linking-to-zulip.mdx
View File

@@ -15,13 +15,13 @@ To embed a Zulip badge, copy and paste the following, replacing
Markdown
```
```md "chat.zulip.org"
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org)
```
HTML
```
```html "chat.zulip.org"
<a href="https://chat.zulip.org"><img src="https://img.shields.io/badge/zulip-join_chat-brightgreen.svg" /></a>
```

2
starlight_help/src/content/docs/saml-authentication.mdx
View File

@@ -182,7 +182,7 @@ providers.
1. In the **Addon: SAML2 Web App** **Settings** tab, set the **Application Callback URL** to
`https://auth.zulipchat.com/complete/saml/`.
1. Edit the **Settings** section to match:
```
```json
{
"audience": "https://zulipchat.com",
"mappings": {