Compare commits
6 Commits
96176d2f0c
...
tmp
| Author | SHA1 | Date | |
|---|---|---|---|
| 00cc795a8e | |||
| d46c56d386 | |||
| d180f06ab0 | |||
| c729ca850b | |||
| 4de49b9d0e | |||
| d2a796e67f |
@@ -8,8 +8,16 @@ on:
|
||||
jobs:
|
||||
build-and-deploy:
|
||||
runs-on: self-hosted
|
||||
container:
|
||||
image: python:3.12-slim
|
||||
options: --volume /var/www/knowledge-base:/var/www/knowledge-base
|
||||
steps:
|
||||
- name: Clone repository
|
||||
- name: Install git
|
||||
run: |
|
||||
apt-get update
|
||||
apt-get install -y --no-install-recommends git
|
||||
|
||||
- name: Checkout repository
|
||||
run: |
|
||||
git clone --depth 1 --branch main https://git.tishenko.dev/tish/knowledge-base.git
|
||||
|
||||
@@ -21,8 +29,8 @@ jobs:
|
||||
|
||||
- name: Deploy site
|
||||
run: |
|
||||
# Удаляем только содержимое /var/www/knowledge-base,
|
||||
# чтобы сохранить права и владельца самой папки
|
||||
cd knowledge-base
|
||||
rm -rf /var/www/knowledge-base/*
|
||||
# Удаляем старую версию сайта
|
||||
rm -rf /var/www/knowledge-base/site
|
||||
# Копируем новую
|
||||
cp -r site/ /var/www/knowledge-base/site/
|
||||
|
||||
@@ -1,11 +1,266 @@
|
||||
# Кастомизация Gitea
|
||||
# Gitea
|
||||
|
||||
Шпаргалки актуальны для Gitea 1.24.
|
||||
|
||||
## Установка с Docker
|
||||
|
||||
Эта заметка лишь дополнение к [документации](https://docs.gitea.com/installation/install-with-docker#basics).
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
# Создаём служебного пользователя
|
||||
sudo useradd --create-home --shell /bin/bash --system gitea
|
||||
|
||||
# Даём пользователю права использовать Docker
|
||||
# Строго говоря это необязательно для разворачивания Gitea,
|
||||
# но скорее всего и ранеры будут запускаться от этого пользователя,
|
||||
# так что ему в любом случае потребуются права на Docker
|
||||
sudo usermod -aG docker gitea
|
||||
|
||||
# Переключаемся на пользователя gitea
|
||||
sudo su - gitea
|
||||
|
||||
# Узнаём его uid и gid
|
||||
id
|
||||
|
||||
# Создаём docker-compose.yml по примеру
|
||||
# Указываем переменные USER, USER_UID и USER_GID и порты
|
||||
nano docker-compose.yml
|
||||
|
||||
# Создаём директорию для данных Gitea из-под пользователя gitea,
|
||||
# иначе Docker сам создаст её из-под root
|
||||
# см. секцию "volumes" в docker-compose.yml
|
||||
mkdir data
|
||||
|
||||
# Запускаем Gitea
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
=== "docker-compose.yml"
|
||||
|
||||
```yaml
|
||||
networks:
|
||||
gitea:
|
||||
external: false
|
||||
|
||||
services:
|
||||
server:
|
||||
image: docker.gitea.com/gitea:1.24.6
|
||||
container_name: gitea
|
||||
environment:
|
||||
- USER=<user>
|
||||
- USER_UID=<uid>
|
||||
- USER_GID=<gid>
|
||||
restart: always
|
||||
networks:
|
||||
- gitea
|
||||
volumes:
|
||||
- ./data:/data
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
ports:
|
||||
- "28500:3000"
|
||||
- "28522:22"
|
||||
```
|
||||
|
||||
Теперь можно перейти по адресу `http://<IPv4>:28500` и завершить установку Gitea.
|
||||
|
||||
Подключиться к контейнеру можно командой.
|
||||
|
||||
```sh
|
||||
docker exec --user gitea -it gitea bash
|
||||
|
||||
# Уже внутри контейнера можно запускать бинарник gitea
|
||||
/usr/local/bin/gitea help
|
||||
```
|
||||
|
||||
## Создание бэкапа
|
||||
|
||||
Ссылка на [документацию](https://docs.gitea.com/administration/backup-and-restore).
|
||||
|
||||
### Gitea установлена из бинарника
|
||||
|
||||
```sh
|
||||
# gitea - это пользователь под которым запущен Gitea, часто это просто git
|
||||
sudo su - gitea
|
||||
|
||||
mkdir gitea-backup
|
||||
cd gitea-backup
|
||||
|
||||
# Нужно указать актуальный путь к конфигу
|
||||
/usr/local/bin/gitea dump -c /etc/gitea/app.ini
|
||||
|
||||
# Если планируется восстановление с другой базой данных,
|
||||
# то нужно указать параметр --database <sqlite3|mysql|postgres>
|
||||
/usr/local/bin/gitea dump --database sqlite3 -c /etc/gitea/app.ini
|
||||
```
|
||||
|
||||
### Gitea установлена с Docker
|
||||
|
||||
Предполагается, что Gitea развёрнута с помощью Docker Compose как описано в инструкции [выше](#установка-с-docker).
|
||||
|
||||
Подключаемся к контейнеру.
|
||||
|
||||
```sh
|
||||
docker exec --user gitea -it gitea bash
|
||||
```
|
||||
|
||||
Внутри контейнера выполняем.
|
||||
|
||||
```sh
|
||||
# Бэкап нужно создать в директории /data, потому что она прокинута на хост
|
||||
cd /data
|
||||
|
||||
# (Опционально) Создаём директорию для бэкапов
|
||||
mkdir backups
|
||||
cd backups
|
||||
|
||||
# Нужно указать актуальный путь к конфигу
|
||||
/usr/local/bin/gitea dump -c /data/gitea/conf/app.ini
|
||||
|
||||
# Если планируется восстановление с другой базой данных,
|
||||
# то нужно указать параметр --database <sqlite3|mysql|postgres>
|
||||
/usr/local/bin/gitea dump --database sqlite3 -c /data/gitea/conf/app.ini
|
||||
```
|
||||
|
||||
То же самое в одну команду.
|
||||
|
||||
```sh
|
||||
docker exec -u gitea -w /data gitea /usr/local/bin/gitea dump -c /data/gitea/conf/app.ini
|
||||
```
|
||||
|
||||
### Перенос бэкапа на другую машину
|
||||
|
||||
Перенести бэкап на другую машину можно, например, так:
|
||||
|
||||
```sh
|
||||
# Запускаем HTTP сервер (с scp загрузка больших файлов займёт много времени)
|
||||
python3 -m http.server 8080
|
||||
|
||||
# На другой машине скачиваем бэкап
|
||||
curl -O http://<IP>:8080/gitea-dump-1760203345.zip
|
||||
```
|
||||
|
||||
|
||||
## Восстановление из бэкапа в Docker
|
||||
|
||||
Предполагается, что Gitea разворачивается из [бэкапа](#создание-бэкапа) с помощью Docker Compose как описано в инструкции [выше](#установка-с-docker). В [документации](https://docs.gitea.com/1.24/administration/backup-and-restore#using-docker-restore) есть соответствующая инструкция, однако она не полная и содержит ошибки.
|
||||
|
||||
```sh
|
||||
# Если создавали пользователя по инструкции выше,
|
||||
# то команды выполняем от него
|
||||
sudo su - gitea
|
||||
|
||||
# Распаковываем бэкап
|
||||
unzip -q gitea-dump-*.zip -d dump
|
||||
|
||||
# Создаём директорию для данных Gitea
|
||||
mkdir data
|
||||
|
||||
# Копируем данные
|
||||
cp -r dump/data/ data/gitea/
|
||||
|
||||
# Копируем репозитории
|
||||
mkdir data/git/
|
||||
cp -r dump/repos/ data/git/repositories/
|
||||
|
||||
# Копируем кастомные стили и шаблоны
|
||||
cp -r dump/custom/. data/gitea/
|
||||
|
||||
# Если Gitea в Docker будет работать с SQLite,
|
||||
# то восстановить базу данных можно так.
|
||||
# Команды для других баз данныех есть в документации
|
||||
sqlite3 data/gitea/gitea.db < dump/gitea-db.sql
|
||||
|
||||
# Копируем конфиг
|
||||
mkdir data/gitea/conf
|
||||
cp dump/app.ini data/gitea/conf/app.ini
|
||||
```
|
||||
|
||||
Если до этого Gitea была запущена не через Docker, то нужно отредактировать конфиг.
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
vim data/gitea/conf/app.ini
|
||||
```
|
||||
|
||||
=== "`app.ini` для Docker"
|
||||
|
||||
Это не полноценный конфиг, а лишь часть настроек для запуска Gitea Docker.
|
||||
Подразумевается, что конфиг был перенесён из бэкапа.
|
||||
|
||||
`SSH_PORT` нужно указать тот же, что и в `docker-compose.yml`.
|
||||
|
||||
```ini
|
||||
RUN_USER = gitea
|
||||
WORK_PATH = /data/gitea
|
||||
|
||||
[server]
|
||||
LOCAL_ROOT_URL = http://localhost:3000
|
||||
APP_DATA_PATH = /data/gitea
|
||||
DOMAIN = localhost
|
||||
SSH_DOMAIN = localhost
|
||||
HTTP_PORT = 3000
|
||||
SSH_PORT = 28522
|
||||
|
||||
[repository]
|
||||
ROOT = /data/git/repositories
|
||||
|
||||
[database]
|
||||
PATH = /data/gitea/gitea.db
|
||||
DB_TYPE = sqlite3
|
||||
HOST = localhost:3306
|
||||
NAME = gitea
|
||||
USER = root
|
||||
PASSWD =
|
||||
LOG_SQL = false
|
||||
|
||||
[lfs]
|
||||
PATH = /data/git/lfs
|
||||
|
||||
[log]
|
||||
ROOT_PATH = /data/gitea/log
|
||||
```
|
||||
|
||||
Запускаем Gitea, скорее всего она начнёт падать с ошибкой `permission denied`, а Docker будет пытаться её перезапустить. При первом запуске Gitea создаёт директории для ssh ключей, но по какой-то причине они создаются из-под `root`, а не из-под пользователя `gitea`.
|
||||
|
||||
```sh
|
||||
# Специально без -d, ждём когда в логах повалятся ошибки и нажимаем Ctrl+C
|
||||
docker compose up
|
||||
```
|
||||
|
||||
Теперь нужно из-под `root` или с помощью `sudo` указать нужные права.
|
||||
|
||||
```sh
|
||||
# Выходим из пользователя gitea (Ctrl + D или exit)
|
||||
# и выполняем команду с root правами
|
||||
sudo chown -R gitea:gitea ~gitea/data
|
||||
```
|
||||
|
||||
Снова запускаем Gitea.
|
||||
|
||||
```sh
|
||||
sudo su - gitea
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Если всё работает корректно, то файлы бэкапа можно удалить.
|
||||
|
||||
```sh
|
||||
rm -rf dump gitea-dump-*.zip
|
||||
```
|
||||
|
||||
|
||||
## Кастомизация Gitea
|
||||
|
||||
Во всех командах подразумевается, что Gitea [установлена из бинарника](https://docs.gitea.com/installation/install-from-binary) и [запускается как `systemd` сервис](https://docs.gitea.com/installation/linux-service).
|
||||
|
||||
В документации есть страница, посвящённая [кастомизации Gitea](https://docs.gitea.com/administration/customizing-gitea).
|
||||
|
||||
|
||||
## Свой `css`
|
||||
### Свой `css`
|
||||
|
||||
Добавляем ссылку на свой файл со стилями.
|
||||
|
||||
@@ -131,7 +386,7 @@ sudo systemctl restart gitea
|
||||
|
||||
После изменения стилей, страницу в браузере нужно обновить с помощью `ctrl + f5`.
|
||||
|
||||
## Настройка `app.ini`
|
||||
### Настройка `app.ini`
|
||||
|
||||
Перечень всех возможных настроек представлен в [документации](https://docs.gitea.com/administration/config-cheat-sheet).
|
||||
|
||||
@@ -172,7 +427,7 @@ sudo systemctl restart gitea
|
||||
sudo systemctl restart gitea
|
||||
```
|
||||
|
||||
## Изменение шаблонов страниц
|
||||
### Изменение шаблонов страниц
|
||||
|
||||
Ищем шаблон для нужной версии в [репозитории Gitea](https://github.com/go-gitea/gitea/tree/main/templates), загружаем с помощью `wget` по такому же пути в `$GITEA_CUSTOM/templates` и редактируем.
|
||||
|
||||
|
||||
@@ -87,6 +87,22 @@ docker compose stop
|
||||
docker compose attach mc
|
||||
```
|
||||
|
||||
### Шпаргалка по командам
|
||||
|
||||
1. `/list` — список игроков.
|
||||
2. `/op <nickname>` — сделать игрока оператором.
|
||||
3. `/deop <nickname>` — удалить из списка операторов.
|
||||
4. Отдельной команды для просмотра списка операторов нет, но он хранится в файле `data/ops.json`.
|
||||
5. `/whitelist <on|off>` — включить или выключить белый список игроков.
|
||||
6. `/whitelist list` — вывести белый список игроков.
|
||||
7. `/whitelist add <nickname>` — добавить игрока в белый список.
|
||||
8. `/whitelist remove <nickname>` — удалить игрока из белого списка.
|
||||
9. `/gamemode <0|1|2|3>` — изменить режим игры (0 — выживание, 1 — креатив, 2 — приключение, 3 — наблюдатель).
|
||||
10. `/time set <day|night|<число>>` — установить время суток.
|
||||
11. `/weather <clear|rain|thunder>` — изменить погоду.
|
||||
12. `/tp <nickname1> <nickname2>` — телепортировать первого игрока ко второму.
|
||||
13. `/difficulty <peaceful|easy|normal|hard>` — изменить уровень сложности сервера.
|
||||
|
||||
## Домен для сервера
|
||||
|
||||
Если порт стандартный (`25565`), то при подключении можно просто указать домен в A-записи которого указан IP-адрес сервера. Однако если порт нестандартный или хочется сделать несколько доменных имён для одного сервера, то можно использовать SRV-записи.
|
||||
|
||||
454
docs/servers/mail.md
Normal file
454
docs/servers/mail.md
Normal file
@@ -0,0 +1,454 @@
|
||||
# Почта on-premise
|
||||
|
||||
Настройка почты на своём сервере со своим доменным именем. В качестве почтового сервера используется [Docker Mailserver](https://github.com/docker-mailserver/docker-mailserver) версии 15.1.0. Вебклиент — [Roundcube Webmail](https://github.com/roundcube/roundcubemail) версии 1.6.11.
|
||||
|
||||
## Открытие портов для почты
|
||||
|
||||
Многие хостинг провайдеры блокируют исходящие соединения на портах 25, 465 и 587, чтобы предотвратить спам или вредоносные рассылки с их серверов. Можно проверить доступность портов с помощью команды `nc`.
|
||||
|
||||
```sh
|
||||
# Выведет "Connection to smtp.gmail.com 25 port [tcp/*] succeeded!",
|
||||
# если порт открыт
|
||||
nc -vz smtp.gmail.com 25
|
||||
nc -vz smtp.gmail.com 465
|
||||
nc -vz smtp.gmail.com 587
|
||||
```
|
||||
|
||||
Если порты закрыты, то можно обратиться в поддержку хостинг провайдера с запросом на открытие портов.
|
||||
|
||||
??? abstract "Пример обращения в поддержку"
|
||||
```
|
||||
Добрый день!
|
||||
|
||||
Прошу разблокировать исходящие соединения на порты 25/tcp, 465/tcp и 587/tcp
|
||||
для моего сервера (<IP-адрес сервера>).
|
||||
Сервер используется для личного почтового домена <домен>, не для массовых рассылок.
|
||||
|
||||
Спасибо!
|
||||
```
|
||||
|
||||
## Настройка DNS
|
||||
|
||||
Настройка DNS на примере домена `tishenko.dev` (почта `@tishenko.dev`). Более подробное описание всех настроек можно прочитать в документации Docker Mailserver: [[1]](https://docker-mailserver.github.io/docker-mailserver/latest/usage/#minimal-dns-setup) и [[2]](https://docker-mailserver.github.io/docker-mailserver/latest/config/best-practices/dkim_dmarc_spf/).
|
||||
|
||||
Со стороны DNS провайдера:
|
||||
|
||||
1. Добавляем поддомен для почты, например, `mail.tishenko.dev` и `www.mail.tishenko.dev`. В A-записи поддомена указываем IP-адрес сервера.
|
||||
|
||||
2. Добавляем MX-запись для основного домена `tishenko.dev`, именно этот домен будет использоваться для отправки и получения почты `@tishenko.dev`.
|
||||
```dns
|
||||
10 mail.tishenko.dev.
|
||||
```
|
||||
Обязательно с точкой в конце. Число 10 это приоритет MX-записи, чем меньше число, тем выше приоритет. Приоритет не играет роли, если запись только одна. MX-записи, созданные DNS провайдером, нужно удалить.
|
||||
|
||||
3. Добавляем TXT-запись для DMARC. Запись надо создать для домена `_dmarc.tishenko.dev.`.
|
||||
```dns
|
||||
v=DMARC1; p=quarantine; sp=quarantine; fo=0; adkim=r; aspf=r; pct=100; rf=afrf; ri=86400; rua=mailto:dmarc.report@tishenko.dev; ruf=mailto:dmarc.report@tishenko.dev
|
||||
```
|
||||
DMARC-записи, созданные DNS провайдером, нужно удалить.
|
||||
|
||||
4. Добавляем TXT-запись для SPF. Запись надо создать для домена `tishenko.dev.`.
|
||||
```dns
|
||||
v=spf1 mx -all
|
||||
```
|
||||
SPF-записи, созданные DNS провайдером, нужно удалить.
|
||||
|
||||
5. Для окончательной настройки нужно также добавить TXT-запись для DKIM. Однако это можно сделать только после настройки почтового сервера и создания пары ключей. Подробнее про настройку DKIM написано [ниже](#настройка-dkim).
|
||||
|
||||
Со стороны владельца IP-адреса, как правило это VDS провайдер, создаём или редактируем PTR запись для IP-адреса почтового сервера. Указываем в ней почтовый адрес: `mail.tishenko.dev.`.
|
||||
|
||||
??? question "Как проверить настройки DNS?"
|
||||
|
||||
Можно использовать [DNS Checker](https://dnschecker.org/) для проверки [A](https://dnschecker.org/#A/mail.tishenko.dev), [MX](https://dnschecker.org/#MX/tishenko.dev), [PTR](https://dnschecker.org/#PTR/146.103.98.219), [DMARC](https://dnschecker.org/#TXT/_dmarc.tishenko.dev) и [SPF](https://dnschecker.org/#TXT/tishenko.dev) записей.
|
||||
|
||||
Либо использовать команду `dig`.
|
||||
|
||||
```sh
|
||||
# Команда должна вывести IP-адрес сервера
|
||||
dig @1.1.1.1 +short A mail.tishenko.dev
|
||||
|
||||
# 10 mail.tishenko.dev.
|
||||
dig @1.1.1.1 +short MX tishenko.dev
|
||||
|
||||
# mail.tishenko.dev.
|
||||
dig @1.1.1.1 +short -x 146.103.98.219
|
||||
|
||||
# Проверить DMARC
|
||||
dig @1.1.1.1 +short TXT _dmarc.tishenko.dev
|
||||
|
||||
# Проверить SPF
|
||||
dig @1.1.1.1 +short TXT tishenko.dev
|
||||
```
|
||||
|
||||
Обновление DNS происходит не мгновенно, обычно это занимает около 20 минут.
|
||||
|
||||
??? abstract "Пример файла зоны"
|
||||
|
||||
В панели управления DNS провайдера можно выгрузить файл зоны и убедиться, что все записи добавились корректно.
|
||||
|
||||
```dns
|
||||
IN MX 10 mail.tishenko.dev.
|
||||
mail IN A 146.103.98.219
|
||||
www.mail IN A 146.103.98.219
|
||||
@ 600 IN TXT "v=spf1 mx -all"
|
||||
_dmarc 600 IN TXT "v=DMARC1; p=quarantine; sp=quarantine; fo=0; adkim=r; aspf=r; pct=100; rf=afrf; ri=86400; rua=mailto:dmarc.report@tishenko.dev; ruf=mailto:dmarc.report@tishenko.dev"
|
||||
```
|
||||
|
||||
## Docker Mailserver
|
||||
|
||||
Docker Mailserver (DMS) имеет отличную [документацию](https://docker-mailserver.github.io/docker-mailserver/latest/usage/). И DNS и почтовый сервер можно настроить просто пройдясь по ней. Эта заметка лишь дополняет документацию.
|
||||
|
||||
```sh
|
||||
# Открываем порты для почты (если используется ufw)
|
||||
sudo ufw allow 25,143,465,587,993/tcp
|
||||
|
||||
# Создаём отдельного пользователя для управления почтой
|
||||
# Пользователь vmail в контейнере DMS по умолчанию имеет uid 5000,
|
||||
# поэтому желательно, чтобы и на хосте он имел такой же uid
|
||||
sudo useradd -u 5000 --create-home --shell /bin/bash vmail
|
||||
sudo usermod -aG docker vmail
|
||||
|
||||
# Переключаемся на пользователя vmail
|
||||
sudo su - vmail
|
||||
|
||||
# Скачиваем compose.yaml и mailserver.env из репозитория DMS
|
||||
# Версия 15.1.0
|
||||
DMS_GITHUB_URL="https://raw.githubusercontent.com/docker-mailserver/docker-mailserver/refs/tags/v15.1.0"
|
||||
wget "${DMS_GITHUB_URL}/compose.yaml"
|
||||
wget "${DMS_GITHUB_URL}/mailserver.env"
|
||||
```
|
||||
|
||||
Теперь нужно отредактировать `compose.yaml` и `mailserver.env`.
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
nano compose.yaml
|
||||
```
|
||||
|
||||
=== "compose.yaml"
|
||||
|
||||
В `image` указываем конкретную версию вместо `:latest`. В `hostname` указываем почтовый домен (e. g. mail.tishenko.dev).
|
||||
|
||||
Также прокидываем в контейнер волюм `/etc/letsencrypt` для подключения SSL сертификатов, актуально если на хосте используется letsencrypt.
|
||||
|
||||
```yaml
|
||||
services:
|
||||
mailserver:
|
||||
image: ghcr.io/docker-mailserver/docker-mailserver:15.1.0
|
||||
container_name: mailserver
|
||||
# Provide the FQDN of your mail server here (Your DNS MX record should point to this value)
|
||||
hostname: mail.tishenko.dev
|
||||
env_file: mailserver.env
|
||||
# More information about the mail-server ports:
|
||||
# https://docker-mailserver.github.io/docker-mailserver/latest/config/security/understanding-the-ports/
|
||||
ports:
|
||||
- "25:25" # SMTP (explicit TLS => STARTTLS, Authentication is DISABLED => use port 465/587 instead)
|
||||
- "143:143" # IMAP4 (explicit TLS => STARTTLS)
|
||||
- "465:465" # ESMTP (implicit TLS)
|
||||
- "587:587" # ESMTP (explicit TLS => STARTTLS)
|
||||
- "993:993" # IMAP4 (implicit TLS)
|
||||
volumes:
|
||||
- ./docker-data/dms/mail-data/:/var/mail/
|
||||
- ./docker-data/dms/mail-state/:/var/mail-state/
|
||||
- ./docker-data/dms/mail-logs/:/var/log/mail/
|
||||
- ./docker-data/dms/config/:/tmp/docker-mailserver/
|
||||
- /etc/localtime:/etc/localtime:ro
|
||||
- /etc/letsencrypt:/etc/letsencrypt:ro
|
||||
restart: always
|
||||
stop_grace_period: 1m
|
||||
# Uncomment if using `ENABLE_FAIL2BAN=1`:
|
||||
# cap_add:
|
||||
# - NET_ADMIN
|
||||
healthcheck:
|
||||
test: "ss --listening --ipv4 --tcp | grep --silent ':smtp' || exit 1"
|
||||
timeout: 3s
|
||||
retries: 0
|
||||
```
|
||||
|
||||
=== "mailserver.env"
|
||||
|
||||
В этой заметке DMS настраивается с антиспамом Rspamd. Как отмечено в [документации](https://docker-mailserver.github.io/docker-mailserver/v15.1/config/security/rspamd/), его планируется использовать по умолчанию в будущих версиях DMS. На той же странице документации перечислены legacy проверки, которые нужно отключить. Тут они также продублированы.
|
||||
|
||||
```sh
|
||||
# Указываем тип SSL сертификатов
|
||||
SSL_TYPE=letsencrypt
|
||||
|
||||
# Включаем Rspamd
|
||||
ENABLE_RSPAMD=1
|
||||
|
||||
# Отключаем legacy проверки, т. к. они уже включены в Rspamd
|
||||
ENABLE_OPENDKIM=0
|
||||
ENABLE_OPENDMARC=0
|
||||
ENABLE_POLICYD_SPF=0
|
||||
ENABLE_AMAVIS=0
|
||||
RSPAMD_GREYLISTING=1
|
||||
```
|
||||
|
||||
```sh
|
||||
# Создаём директории для волюмов DMS заранее,
|
||||
# чтобы у них был правильный владелец (vmail)
|
||||
mkdir -p ./docker-data/dms/{mail-data,mail-state,mail-logs,config}
|
||||
|
||||
# Запускаем DMS
|
||||
docker compose up -d
|
||||
|
||||
# В течение двух минут после первого запуска DMS нужно создать хотя бы один
|
||||
# почтовый адрес, иначе контейнер завершится с ошибкой
|
||||
# Команда предложит задать пароль для нового почтового аккаунта
|
||||
docker exec -it mailserver setup email add artem@tishenko.dev
|
||||
|
||||
# Обязательно добавляем alias для адреса postmaster
|
||||
docker exec -it mailserver setup alias add postmaster@tishenko.dev artem@tishenko.dev
|
||||
```
|
||||
|
||||
### Настройка SSL
|
||||
|
||||
В документации DMS есть отдельная [страница](https://docker-mailserver.github.io/docker-mailserver/latest/config/security/ssl/) про настройку SSL сертификатов.
|
||||
|
||||
Далее подразумевается, что волюм `/etc/letsencrypt` уже прокинут в контейнер, а также в `mailserver.env` указана переменная `SSL_TYPE=letsencrypt`.
|
||||
|
||||
Получаем сертификаты. Команды нужно выполнять от пользователя с правом использовать `sudo`. `certbot` можно установить с помощью [pip](https://certbot.eff.org/instructions?ws=other&os=pip).
|
||||
|
||||
```sh
|
||||
# Порт 80 нужен для получения и обновления сертификатов
|
||||
sudo ufw allow 80/tcp
|
||||
|
||||
# Если на сервере есть nginx или другой веб-сервер, используем соответствующий флаг
|
||||
sudo certbot certonly --nginx -d mail.tishenko.dev -d www.mail.tishenko.dev
|
||||
|
||||
# Если на сервере нет nginx (порт 80 не должен быть занят)
|
||||
sudo certbot certonly --standalone -d mail.tishenko.dev -d www.mail.tishenko.dev
|
||||
```
|
||||
|
||||
|
||||
### Настройка DKIM
|
||||
|
||||
В документации DMS есть отдельная [страница](https://docker-mailserver.github.io/docker-mailserver/latest/config/best-practices/dkim_dmarc_spf/) про настройку DKIM, DMARC и SPF. Про настройку DMARC и SPF написано [выше](#настройка-dns), а вот для настройки DKIM нужно сначала сгенерировать пару ключей. Публичный ключ как раз и указывается в DKIM.
|
||||
|
||||
Команда для генерации ключей. DMS должен быть запущен.
|
||||
|
||||
```sh
|
||||
# Выведет в консоль значение для TXT-записи
|
||||
# Также её можно узнать в файле
|
||||
# cat ./docker-data/dms/config/rspamd/dkim/rsa-2048-mail-tishenko.dev.public.dns.txt
|
||||
docker exec -it mailserver setup config dkim domain tishenko.dev
|
||||
```
|
||||
|
||||
Теперь добавляем TXT запись для DKIM в DNS. Имя записи должно быть `mail._domainkey.tishenko.dev.`. Проверить запись можно с помощью сайта [DNS Checker](https://dnschecker.org/#TXT/mail._domainkey.tishenko.dev) или команды `dig`.
|
||||
|
||||
```sh
|
||||
# Должна вывести "v=DKIM1; k=rsa; p=<публичный ключ>"
|
||||
dig @1.1.1.1 +short TXT mail._domainkey.tishenko.dev
|
||||
```
|
||||
|
||||
### Проверка
|
||||
|
||||
Работоспособность и настройки DMS можно проверить с помощью сайта [Mail-Tester](https://www.mail-tester.com/).
|
||||
|
||||
Пример команды для отправки тестового письма.
|
||||
```sh
|
||||
docker exec -it mailserver swaks \
|
||||
--to <адрес с mail-tester> \
|
||||
--from artem@tishenko.dev \
|
||||
--server mail.tishenko.dev \
|
||||
--port 587 \
|
||||
--tls \
|
||||
--auth LOGIN \
|
||||
--auth-user artem@tishenko.dev \
|
||||
--auth-password 'password'
|
||||
```
|
||||
|
||||
Если письмо дойдёт до тестового адреса, то сайт выведет результаты проверки DNS-записей и общую оценку настройки почтового сервера. Если всё сделано правильно, то оценка будет 10/10.
|
||||
|
||||
Дополнительно можно проверить настройки почтового сервера с помощью сайта [MX Toolbox](https://mxtoolbox.com/emailhealth).
|
||||
|
||||
### Администрирование
|
||||
|
||||
Администрировать DMS можно через скрипт `setup` внутри контейнера. Для этого можно подключиться к контейнеру с помощью команды.
|
||||
|
||||
```sh
|
||||
docker exec -it mailserver bash
|
||||
|
||||
# Уже внутри контейнера
|
||||
setup help
|
||||
```
|
||||
|
||||
Если нужно выполнить всего одну команду, то можно не запускать bash.
|
||||
|
||||
```sh
|
||||
docker exec -it mailserver setup help
|
||||
```
|
||||
|
||||
|
||||
## Roundcube
|
||||
|
||||
Roundcube проще всего развернуть с помощью Docker Compose. Актуальную версию образа можно выбрать на [Docker Hub](https://hub.docker.com/r/roundcube/roundcubemail). Там же можно посмотреть список переменных окружения и их значения. Далее подразумевается, что выбран образ `apache-nonroot`, а также что для управления почтой создан отдельный пользователь `vmail` с uid/gid 5000, как показано в инструкции [выше](#настройка-docker-mailserver).
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
# Переключаемся на пользователя vmail
|
||||
sudo su - vmail
|
||||
|
||||
mkdir ./roundcube
|
||||
cd ./roundcube
|
||||
|
||||
# Создаём директории для волюмов Roundcube заранее,
|
||||
# чтобы у них был правильный владелец (vmail)
|
||||
mkdir -p ./roundcube/{app,config,db,tmp}
|
||||
|
||||
nano docker-compose.yml
|
||||
```
|
||||
|
||||
=== "Пример docker-compose.yml"
|
||||
|
||||
```yaml
|
||||
services:
|
||||
roundcube:
|
||||
image: roundcube/roundcubemail:1.6.11-apache-nonroot
|
||||
container_name: roundcube
|
||||
restart: always
|
||||
user: "5000:5000"
|
||||
ports:
|
||||
- "25025:8000"
|
||||
environment:
|
||||
# IMAP
|
||||
- ROUNDCUBEMAIL_DEFAULT_HOST=ssl://mail.tishenko.dev
|
||||
- ROUNDCUBEMAIL_DEFAULT_PORT=993
|
||||
|
||||
# SMTP
|
||||
- ROUNDCUBEMAIL_SMTP_SERVER=tls://mail.tishenko.dev
|
||||
- ROUNDCUBEMAIL_SMTP_PORT=587
|
||||
- ROUNDCUBEMAIL_SMTP_USER=%u
|
||||
- ROUNDCUBEMAIL_SMTP_PASS=%p
|
||||
|
||||
# DB
|
||||
- ROUNDCUBEMAIL_DB_TYPE=sqlite
|
||||
|
||||
# Misc
|
||||
- ROUNDCUBEMAIL_USERNAME_DOMAIN=tishenko.dev
|
||||
volumes:
|
||||
- ./roundcube/app:/var/www/html
|
||||
- ./roundcube/config:/var/roundcube/config
|
||||
- ./roundcube/db:/var/roundcube/db
|
||||
- ./roundcube/tmp:/tmp/roundcube-temp
|
||||
```
|
||||
|
||||
Теперь Roundcube доступен на `http://localhost:25025`, чтобы его можно было использовать извне, нужно настроить nginx или аналогичный веб-сервер.
|
||||
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
sudo nano /etc/nginx/sites-available/mail.conf
|
||||
sudo ln -s /etc/nginx/sites-available/mail.conf /etc/nginx/sites-enabled/
|
||||
```
|
||||
|
||||
=== "Пример nginx конфига"
|
||||
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name mail.tishenko.dev www.mail.tishenko.dev;
|
||||
|
||||
client_max_body_size 25m;
|
||||
|
||||
location / {
|
||||
proxy_pass http://127.0.0.1:25025;
|
||||
include proxy_params;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Установить SSL сертификат можно с помощью certbot. Причём если сертификат уже был получен на этапе [настройки DMS](#настройка-ssl), то certbot предложит использовать его.
|
||||
|
||||
```sh
|
||||
sudo certbot --nginx -d mail.tishenko.dev -d www.mail.tishenko.dev
|
||||
```
|
||||
|
||||
### Конфиг
|
||||
|
||||
Некоторые настройки Roundcube нельзя задать через переменные окружения, они задаются в файле `config.inc.php`. Например, "название продукта", оно отображается в заголовке страницы, на странице входа и в других местах. По умолчанию это `Roundcube Webmail`. Его можно изменить в `config/config.inc.php`.
|
||||
|
||||
=== "Терминал"
|
||||
|
||||
```sh
|
||||
nano roundcube/config/config.inc.php
|
||||
```
|
||||
|
||||
=== "config.inc.php"
|
||||
|
||||
```php
|
||||
<?php
|
||||
$config['product_name'] = 'Tish\'s Mail';
|
||||
```
|
||||
|
||||
### Настройки аккаунта
|
||||
|
||||
Настройки, относящиеся к конкретному аккаунту, можно задать через UI. Как минимум стоит установить отображаемое имя, иначе у получателей будет отображаться только адрес электронной почты: `Настройки` -> `Профили` -> `Отображаемое имя`. В разделе с профилями также можно указать подпись для писем.
|
||||
|
||||
Roundcube позволяет задать несколько профилей и соответствующих адресов для одного аккаунта и легко переключаться между ними через UI. Для этого в DMS нужно создать алиас для основного адреса, а затем добавить профиль через UI Roundcube в разделе `Настройки` -> `Профили`.
|
||||
|
||||
```sh
|
||||
docker exec -it mailserver setup email add <алиас> <основной адрес>
|
||||
```
|
||||
|
||||
### Внешний вид
|
||||
|
||||
Подразумевается, что прокинут волюм `./roundcube/app:/var/www/html`. Чтобы внешние изменения не терялись при перезапуске контейнера, нужно создать свою тему для Roundcube на основе темы по умолчанию и изменять её.
|
||||
|
||||
```sh
|
||||
# Желательно выполнять команды от пользователя vmail,
|
||||
# чтобы не было проблем с правами
|
||||
# Либо подключиться к контейнеру через docker exec -it roundcube bash
|
||||
# и редактировать темы из контейнера
|
||||
sudo su - vmail
|
||||
|
||||
# Переходим в директорию с docker-compose.yml для Roundcube
|
||||
cd ./roundcube
|
||||
|
||||
# В разделе environment добавляем переменную окружения
|
||||
# ROUNDCUBEMAIL_SKIN=custom
|
||||
nano docker-compose.yml
|
||||
|
||||
# Копируем тему по умолчанию
|
||||
# Roundcube должен был быть запущен хотя бы один раз,
|
||||
# чтобы тема по умолчанию появилась в волюме
|
||||
cp -r ./roundcube/app/skins/elastic/ ./roundcube/app/skins/custom/
|
||||
|
||||
# Перезапускаем Roundcube
|
||||
docker compose down
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Теперь любые изменения в теме `custom` будут сохраняться при перезапуске контейнера.
|
||||
|
||||
Подробнее про темы Roundcube можно посмотреть в [документации](https://github.com/roundcube/roundcubemail/wiki/Skins).
|
||||
|
||||
#### Favicon
|
||||
|
||||
Favicon находится в `skins/custom/images/favicon.ico`. Достаточно просто заменить его на свой.
|
||||
|
||||
```sh
|
||||
cp your-favicon.ico ./roundcube/app/skins/custom/images/favicon.ico
|
||||
```
|
||||
|
||||
#### Логотип
|
||||
|
||||
Логотип находится в `skins/custom/images/logo.svg`. Достаточно просто заменить его на свой.
|
||||
|
||||
```sh
|
||||
cp your-logo.svg ./roundcube/app/skins/custom/images/logo.svg
|
||||
```
|
||||
|
||||
|
||||
## Логотип в письмах
|
||||
|
||||
Для того чтобы у получателей вместо плейсхолдера рядом с именем отправителя отображался логотип, нужно добавить BIMI TXT-запись в DNS для домена `default._bimi.tishenko.dev.`. Нужно будет настроить Nginx или другой веб-сервер, чтобы логотип был доступен по указанному в BIMI адресу.
|
||||
|
||||
```dns
|
||||
v=BIMI1; l=https://tishenko.dev/logo.svg;
|
||||
```
|
||||
|
||||
Однако в gmail и некоторых других почтовых клиентах он всё равно не будет отображаться, так как они требуют для этого платные VMC сертификаты.
|
||||
@@ -153,6 +153,11 @@ SSL-сертификат получается и устанавливается
|
||||
sudo ufw enable
|
||||
```
|
||||
|
||||
Либо насовсем открыть порт 80, тогда и `renew` точно будет работать.
|
||||
|
||||
```sh
|
||||
sudo ufw allow 80/tcp
|
||||
```
|
||||
|
||||
Несколько полезных команд.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user