Merge pull request 'add tabs to ssh how to, fix md, typos' (#46) from add_tabs_to_ssh_how_to into master
continuous-integration/drone/push Build is passing Details

Reviewed-on: #46
Reviewed-by: Inex Code <inex.code@selfprivacy.org>
pull/47/head^2
Inex Code 2023-09-04 14:16:04 +03:00
commit 10a8e3de13
8 changed files with 101 additions and 46 deletions

View File

@ -62,14 +62,15 @@ We would like to add support for new hosting providers, but at the moment all th
Those who don't ask for a passport or other substantial proof of identity tend to create problems for email traffic - they send spam from them. For example, scaleway's emails are blocked and you have to write to support to get them unblocked. This severely disrupts the end-to-end process of using the email service in SelfPrivacy. Those who don't ask for a passport or other substantial proof of identity tend to create problems for email traffic - they send spam from them. For example, scaleway's emails are blocked and you have to write to support to get them unblocked. This severely disrupts the end-to-end process of using the email service in SelfPrivacy.
## What we use as an email server ## What do we use as our email server?
On the deployed server, the following components are responsible for sending, receiving, filtering emails: On the deployed server, the following components are responsible for sending, receiving, filtering emails:
- Postfix - SMTP server; - Postfix SMTP server;
- Dovecot 2 - IMAP server; - Dovecot 2 IMAP server;
- Rspamd - SPAM filter; - Rspamd SPAM filter;
You can read more about using email on the [service page](https://selfprivacy.org/docs/services/email/).
## Why use CloudFlare? ## Why use CloudFlare?

View File

@ -107,22 +107,22 @@ SelfPrivacy application uses them to manage services in all accounts instead of
We do not need a token for your domain registrar. But we need a DNS provider token to manage the domain. We do not need a token for your domain registrar. But we need a DNS provider token to manage the domain.
SelfPrivacy supports two providers to choose from: the popular [Cloudflare] (https://www.cloudflare.com/) and the privacy-focused [deSEC] (https://desec.io/). SelfPrivacy supports two providers to choose from: the popular [Cloudflare](https://www.cloudflare.com/) and the privacy-focused [deSEC](https://desec.io/).
{{< tabpane text=true >}} {{< tabpane text=true >}}
{{% tab "deSEC" %}} {{% tab "deSEC" %}}
### If you chose deSEC: How to get a token ### If you have chosen deSEC: How to get a token
1. Log in at: https://desec.io/login 1. Log in [here](https://desec.io/login).
2. Go to **Domains** page at: https://desec.io/domains 2. Go to the [Domains page](https://desec.io/domains).
3. Go to **Token management** tab. 3. Go to the **Token management** tab.
4. Click on the round "plus" button in the upper right corner. 4. Click on the round "plus" button in the upper right corner.
{{< imgproc desec-tokenmanagment Fill "626x287">}} {{< imgproc desec-tokenmanagment Fill "626x287" />}}
{{< /imgproc >}}
5. "**Generate New Token**" dialogue must be displayed. Enter any **Token name** you wish. Advanced settings are not required, so do not touch anything there. 5. "**Generate New Token**" dialogue must be displayed. Enter any **Token name** you wish. Advanced settings are not required, so do not touch anything there.
@ -130,8 +130,8 @@ SelfPrivacy supports two providers to choose from: the popular [Cloudflare] (htt
7. Make sure you save the token's "**secret value**" as it will only be displayed once. 7. Make sure you save the token's "**secret value**" as it will only be displayed once.
{{< imgproc dncsec-copy Fill "626x287">}} {{< imgproc dncsec-copy Fill "626x287" />}}
{{< /imgproc >}}
8. Now you can safely **close** the dialogue. 8. Now you can safely **close** the dialogue.
@ -139,7 +139,7 @@ SelfPrivacy supports two providers to choose from: the popular [Cloudflare] (htt
{{% tab "Cloudflare" %}} {{% tab "Cloudflare" %}}
### If you chose Cloudflare: How to get a token ### If you have chosen Cloudflare: How to get a token
{{< video src="Cloudflare" muted="true" autoplay="true" autoplay="true" loop="true" >}} {{< video src="Cloudflare" muted="true" autoplay="true" autoplay="true" loop="true" >}}
@ -149,8 +149,8 @@ SelfPrivacy supports two providers to choose from: the popular [Cloudflare] (htt
click on the **menu** button with three horizontal bars in the upper left corner). click on the **menu** button with three horizontal bars in the upper left corner).
From the menu that appears, click **My Profile**. From the menu that appears, click **My Profile**.
{{< imgproc cloudflare-my-profile Fill "626x287">}} {{< imgproc cloudflare-my-profile Fill "626x287" />}}
{{< /imgproc >}}
3. We have four configuration categories to choose from: **Preferences**, **Authentication**, 3. We have four configuration categories to choose from: **Preferences**, **Authentication**,
**API Tokens** and **Sessions**. Select **API Tokens**. **API Tokens** and **Sessions**. Select **API Tokens**.
@ -169,9 +169,9 @@ In the second field, in the middle, select **DNS**. In the last field, select **
Voila, we have new fields. Let's fill them in the same way as in the previous section, in the first field Voila, we have new fields. Let's fill them in the same way as in the previous section, in the first field
we choose **Zone**, in the second one also **Zone**. And in the third one we press **Read**. Let's check what we have: we choose **Zone**, in the second one also **Zone**. And in the third one we press **Read**. Let's check what we have:
{{< imgproc cloudflare-permissions Fill "628x203">}} {{< imgproc cloudflare-permissions Fill "628x203" />}}
Your selection must look like this. Your selection must look like this.
{{< /imgproc >}}
9. Next, look at **Zone Resources**. Below this heading there is a line with two fields. 9. Next, look at **Zone Resources**. Below this heading there is a line with two fields.
The first should be **Include**, and the second should be **Specific Zone**. The first should be **Include**, and the second should be **Specific Zone**.

View File

@ -12,7 +12,10 @@ To access your server's root shell you will have to generate your SSH key and ad
## How to generate SSH key ## How to generate SSH key
### Unix-like systems (PC)
{{< tabpane text=true >}}
{{% tab "Unix-like systems (PC)" %}}
### If you are a Unix-like system user
1. Open the terminal. 1. Open the terminal.
2. Run the following command: 2. Run the following command:
@ -27,7 +30,10 @@ To access your server's root shell you will have to generate your SSH key and ad
``` ```
4. Refer to the next section to add the key to your server. 4. Refer to the next section to add the key to your server.
### Windows {{% /tab %}}
{{% tab "Windows" %}}
### If you are a Windows user
1. Open settings and under "Applications" click on "Manage additional components". 1. Open settings and under "Applications" click on "Manage additional components".
2. Press "Add Component". 2. Press "Add Component".
@ -46,7 +52,11 @@ To access your server's root shell you will have to generate your SSH key and ad
Once again, replace `user_name` with your Windows username. Once again, replace `user_name` with your Windows username.
7. Refer to the next section to add the key to your server. 7. Refer to the next section to add the key to your server.
### Android (Termux)
{{% /tab %}}
{{% tab "Android (Termux)" %}}
### If you are a Android (Termux) user
0. Install [Termux](https://termux.dev/en/). We recommend installing it from F-Droid. 0. Install [Termux](https://termux.dev/en/). We recommend installing it from F-Droid.
1. Open Termux. 1. Open Termux.
@ -63,6 +73,10 @@ To access your server's root shell you will have to generate your SSH key and ad
``` ```
4. Refer to the next section to add the key to your server. 4. Refer to the next section to add the key to your server.
{{% /tab %}}
{{< /tabpane >}}
## How to add the key to your server ## How to add the key to your server
0. Open the SelfPrivacy app. 0. Open the SelfPrivacy app.
@ -75,8 +89,9 @@ To access your server's root shell you will have to generate your SSH key and ad
7. Tap on the "Start" button. 7. Tap on the "Start" button.
8. In a few minutes, you will be able to access your server's root shell via SSH. 8. In a few minutes, you will be able to access your server's root shell via SSH.
{{< imgproc more-superuser Fill "1001x808">}} {{< imgproc more-superuser Fill "1001x808" />}}
{{< /imgproc >}}
## How to access your server's root shell via SSH ## How to access your server's root shell via SSH

View File

@ -42,8 +42,15 @@ Username: `your username @ your domain` (your full email address)
- [FairEmail](https://f-droid.org/packages/eu.faircode.email/) (Android) - [FairEmail](https://f-droid.org/packages/eu.faircode.email/) (Android)
Configuration example for [Mozilla Thunderbird](https://www.thunderbird.net) Configuration example for [Mozilla Thunderbird](https://www.thunderbird.net)
{{< imgproc thunderbird Fill "1000x950">}} {{< imgproc thunderbird Fill "1000x950" />}}
{{< /imgproc >}}
## What do we use as our email server?
On the deployed server, the following components are responsible for sending, receiving, filtering emails:
- Postfix — SMTP server;
- Dovecot 2 — IMAP server;
- Rspamd — SPAM filter;
## Tips ## Tips

View File

@ -62,9 +62,11 @@ Self-hosted - это термин, означающий, что онлайн-с
На развернутом сервере следующие компоненты отвечают за отправку, получение и фильтрацию электронной почты: На развернутом сервере следующие компоненты отвечают за отправку, получение и фильтрацию электронной почты:
- Postfix - SMTP-сервер; - Postfix — SMTP-сервер;
- Dovecot 2 - IMAP сервер; - Dovecot 2 — IMAP сервер;
- Rspamd - SPAM-фильтр. - Rspamd — SPAM-фильтр.
Подробнее про использование электронной почты, вы можете прочитать на [странице сервиса](https://selfprivacy.org/ru/docs/services/email/).
## Почему стоит использовать CloudFlare? ## Почему стоит использовать CloudFlare?

View File

@ -104,18 +104,20 @@ description: >
SelfPrivacy поддерживает двух провайдеров на выбор: популярный [Cloudflare](https://www.cloudflare.com/) и нацеленный на приватность [deSEC](https://desec.io/). SelfPrivacy поддерживает двух провайдеров на выбор: популярный [Cloudflare](https://www.cloudflare.com/) и нацеленный на приватность [deSEC](https://desec.io/).
{{< tabpane text=true >}}
{{% tab "deSEC" %}}
### Если вы выбрали deSEC: Как получить токен ### Если вы выбрали deSEC: Как получить токен
1. Авторизуемся в deSEC: https://desec.io/login 1. Авторизуемся в [deSEC](https://desec.io/login)
2. Переходим на страницу **Domains** по ссылке: https://desec.io/domains 2. Переходим на страницу [Domains](https://desec.io/domains)
3. Переходим на вкладку **Token management**. 3. Переходим на вкладку **Token management**.
4. Нажимаем на большую кнопку с "плюсом" в правом верхнем углу страницы. 4. Нажимаем на большую кнопку с "плюсом" в правом верхнем углу страницы.
{{< imgproc desec-tokenmanagment Fill "626x287">}} {{< imgproc desec-tokenmanagment Fill "626x287" />}}
{{< /imgproc >}}
5. Должен был появиться "**Generate New Token**" диалог. Вводим любое имя токена в **Token name**. 5. Должен был появиться "**Generate New Token**" диалог. Вводим любое имя токена в **Token name**.
*Advanced settings* необязательны, так что ничего там не трогаем. *Advanced settings* необязательны, так что ничего там не трогаем.
@ -124,12 +126,14 @@ SelfPrivacy поддерживает двух провайдеров на выб
7. Обязательно сохраняем "**secret value**" ключ токена, потому что он отображается исключительно один раз. 7. Обязательно сохраняем "**secret value**" ключ токена, потому что он отображается исключительно один раз.
{{< imgproc dncsec-copy Fill "626x287">}} {{< imgproc dncsec-copy Fill "626x287" />}}
{{< /imgproc >}}
8. Теперь спокойно закрываем диалог, нажав **close**. 8. Теперь спокойно закрываем диалог, нажав **close**.
{{% /tab %}}
{{% tab "Cloudflare" %}}
### Если вы выбрали Cloudflare: Как получить токен ### Если вы выбрали Cloudflare: Как получить токен
@ -141,8 +145,8 @@ SelfPrivacy поддерживает двух провайдеров на выб
2. В правом верхнем углу кликаем на иконку профиля (для мобильной версии сайта: в верхнем левом углу нажимаем 2. В правом верхнем углу кликаем на иконку профиля (для мобильной версии сайта: в верхнем левом углу нажимаем
кнопку **Меню** с тремя горизонтальными полосками). В выпавшем меню кликаем на пункт **My Profile**. кнопку **Меню** с тремя горизонтальными полосками). В выпавшем меню кликаем на пункт **My Profile**.
{{< imgproc cloudflare-my-profile Fill "626x287">}} {{< imgproc cloudflare-my-profile Fill "626x287" />}}
{{< /imgproc >}}
3. Нам предлагается на выбор, четыре категории настройки: **Preferences**, **Authentication**, **API Tokens**, 3. Нам предлагается на выбор, четыре категории настройки: **Preferences**, **Authentication**, **API Tokens**,
**Sessions**. Выбираем **API Tokens**. **Sessions**. Выбираем **API Tokens**.
@ -163,9 +167,9 @@ SelfPrivacy поддерживает двух провайдеров на выб
в первом поле выбираем **Zone**, во-втором тоже **Zone**. А уже в третьем нажимаем на **Read**. в первом поле выбираем **Zone**, во-втором тоже **Zone**. А уже в третьем нажимаем на **Read**.
Давайте сверим с тем, что у вас получилось: Давайте сверим с тем, что у вас получилось:
{{< imgproc cloudflare-permissions Fill "628x203">}} {{< imgproc cloudflare-permissions Fill "628x203" />}}
Ваш выбор должен выглядеть так. Ваш выбор должен выглядеть так.
{{< /imgproc >}}
8. Далее смотрим на **Zone Resources**. Под этой надписью есть строка с двумя полями. 8. Далее смотрим на **Zone Resources**. Под этой надписью есть строка с двумя полями.
В первом должно быть **Include**, а во втором — **Specific Zone**. Как только Вы выберите **Specific Zone**, В первом должно быть **Include**, а во втором — **Specific Zone**. Как только Вы выберите **Specific Zone**,
@ -179,6 +183,9 @@ SelfPrivacy поддерживает двух провайдеров на выб
12. Копируем созданный токен. 12. Копируем созданный токен.
{{% /tab %}}
{{< /tabpane >}}
### Как получить токен для провайдера сервера ### Как получить токен для провайдера сервера
{{< alert title="Не держите яйца в одной корзине" color="warning" >}} {{< alert title="Не держите яйца в одной корзине" color="warning" >}}
Если вы планируете использовать DigitalOcean и для сервера, и для DNS (что мы не рекомендуем), Если вы планируете использовать DigitalOcean и для сервера, и для DNS (что мы не рекомендуем),

View File

@ -12,7 +12,10 @@ categories: ["How-To Guides"]
## Как сгенерировать SSH-ключ ## Как сгенерировать SSH-ключ
### Unix-подобные системы (ПК)
{{< tabpane text=true >}}
{{% tab "Unix-подобная система (ПК)" %}}
### Если вы используете Unix-подобную систему
1. Откройте терминал. 1. Откройте терминал.
2. Выполните следующую команду: 2. Выполните следующую команду:
@ -20,6 +23,7 @@ categories: ["How-To Guides"]
ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519
``` ```
Вам будет предложено ввести кодовую фразу. Вы можете оставить ее пустой, но рекомендуется все-таки использовать пароль. Вам будет предложено ввести кодовую фразу. Вы можете оставить ее пустой, но рекомендуется все-таки использовать пароль.
Если вы не хотите использовать кодовую фразу, просто нажмите **Enter**. Если вы не хотите использовать кодовую фразу, просто нажмите **Enter**.
3. Выведите открытый ключ в терминал и скопируйте его: 3. Выведите открытый ключ в терминал и скопируйте его:
```bash ```bash
@ -27,7 +31,10 @@ categories: ["How-To Guides"]
``` ```
4. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер. 4. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер.
### Windows {{% /tab %}}
{{% tab "Windows" %}}
### Если вы используете Windows
1. Откройте настройки и в разделе "Приложения" нажмите на "Управление дополнительными компонентами". 1. Откройте настройки и в разделе "Приложения" нажмите на "Управление дополнительными компонентами".
2. Нажмите "Добавить компонент". 2. Нажмите "Добавить компонент".
@ -38,6 +45,7 @@ categories: ["How-To Guides"]
ssh-keygen -t ed25519 -f C:\Users\user_name\.ssh\id_ed25519.pub ssh-keygen -t ed25519 -f C:\Users\user_name\.ssh\id_ed25519.pub
``` ```
Вам будет предложено ввести кодовую фразу. Вы можете оставить ее пустой, но рекомендуется использовать кодовую фразу. Вам будет предложено ввести кодовую фразу. Вы можете оставить ее пустой, но рекомендуется использовать кодовую фразу.
Если вы не хотите использовать кодовую фразу, нажмите **Enter**. Если вы не хотите использовать кодовую фразу, нажмите **Enter**.
6. Выведите открытый ключ на терминал и скопируйте его: 6. Выведите открытый ключ на терминал и скопируйте его:
```ps1 ```ps1
@ -46,7 +54,10 @@ categories: ["How-To Guides"]
Еще раз, замените `user_name` на ваше имя пользователя Windows. Еще раз, замените `user_name` на ваше имя пользователя Windows.
7. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер. 7. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер.
### Android (Termux) {{% /tab %}}
{{% tab "Android (Termux)" %}}
### Если вы используете Android (Termux)
0. Установите [Termux](https://termux.dev/en/). Мы рекомендуем установить его из F-Droid. 0. Установите [Termux](https://termux.dev/en/). Мы рекомендуем установить его из F-Droid.
1. Откройте Termux. 1. Откройте Termux.
@ -55,7 +66,8 @@ categories: ["How-To Guides"]
apt update -y && apt upgrade -y && apt install open-ssh -y && apt update -y && apt upgrade -y && apt install open-ssh -y &&
ssh-keygen -t ed25519 -f /data/data/com.termux/files/usr/etc/ssh/ssh_host_ed25519_key ssh-keygen -t ed25519 -f /data/data/com.termux/files/usr/etc/ssh/ssh_host_ed25519_key
``` ```
Вам будет предложено ввести кодовую фразу. Вам будет предложено ввести кодовую фразу. Вы можете оставить ее пустой, но рекомендуется использовать кодовую фразу.
Если вы не хотите использовать кодовую фразу, нажмите **Enter**. Если вы не хотите использовать кодовую фразу, нажмите **Enter**.
3. Выведите открытый ключ в терминал и скопируйте его: 3. Выведите открытый ключ в терминал и скопируйте его:
```bash ```bash
@ -63,6 +75,11 @@ categories: ["How-To Guides"]
``` ```
4. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер. 4. Обратитесь к следующему разделу, чтобы добавить ключ на ваш сервер.
{{% /tab %}}
{{< /tabpane >}}
## Как добавить ключ на ваш сервер ## Как добавить ключ на ваш сервер
0. Откройте приложение SelfPrivacy. 0. Откройте приложение SelfPrivacy.
@ -75,8 +92,8 @@ categories: ["How-To Guides"]
7. Нажмите на кнопку "Начать". 7. Нажмите на кнопку "Начать".
8. Через несколько минут вы сможете получить доступ к корневой оболочке вашего сервера через SSH. 8. Через несколько минут вы сможете получить доступ к корневой оболочке вашего сервера через SSH.
{{< imgproc more-superuser Fill "1001x808">}} {{< imgproc more-superuser Fill "1001x808" />}}
{{< /imgproc >}}
## Как получить доступ к корневой оболочке вашего сервера по SSH ## Как получить доступ к корневой оболочке вашего сервера по SSH

View File

@ -42,9 +42,15 @@ IMAP порт: `143`
- [FairEmail](https://f-droid.org/packages/eu.faircode.email/) (Android) - [FairEmail](https://f-droid.org/packages/eu.faircode.email/) (Android)
Пример конфигурации для [Mozilla Thunderbird](https://www.thunderbird.net) Пример конфигурации для [Mozilla Thunderbird](https://www.thunderbird.net)
{{< imgproc thunderbird Fill "1000x950">}} {{< imgproc thunderbird Fill "1000x950" />}}
{{< /imgproc >}}
## Что используем для электронной почты?
На развернутом сервере следующие компоненты отвечают за отправку, получение и фильтрацию электронной почты:
- Postfix — SMTP-сервер;
- Dovecot 2 — IMAP сервер;
- Rspamd — SPAM-фильтр;
## Советы ## Советы