Сообщество / Гайды

Файл README на сервере: письмо себе через год

lexa92
Middle
Сообщения: 166
Репутация: 146
Дата регистрации:
09.08.2026
АВТОР ТЕМЫ01 нояб. 2026 г., 11:00 (GMT+3)
Вчера вечером полез обновлять свою маленькую VPS. Поднимал её прошлой осенью под три задачи: rsync-бэкап домашнего архива, проверка доступности одного сайта и скрипт, который шлёт уведомления в телеграм. Обновил пакеты, заглянул в crontab, чтобы ничего не сломать после перезапуска, и увидел строку:

0 4 * * * /opt/sync/run.sh >/dev/null 2>&1


Что такое /opt/sync, я не помнил. Внутри скрипт на несколько десятков строк, без единого комментария. Он забирает что-то по адресу, который мне ничего не говорит, и складывает в каталог, о котором я тоже забыл. Вывод уходит в /dev/null, поэтому даже не видно, отработал ли он хоть раз за последний месяц. Автор скрипта — я. Год назад мне всё было очевидно.

В итоге разобрался: остаток старой схемы бэкапа, который давно ничего не делал, потому что источник переехал. Но вывод отсюда другой. На сервере, который обслуживает один человек, документацией обычно служит его память. Память — плохое хранилище: в ней нет поиска, нет истории, и она не переживает отпуск.

С тех пор на каждой машине лежит один файл, /root/README.md. Не вики, не отдельная система, просто текст рядом с тем, что он описывает. Структура у меня такая.

1. Зачем этот сервер. Одна-две строки. «Бэкапы домашнего архива и мониторинг сайта». Если назначение не укладывается в две строки, это уже повод подумать.

2. Что запущено и почему. Каждая служба, каждый таймер, каждая строка cron — с пояснением, что она делает и что сломается, если её выключить. Последнее важнее первого: через год вопрос будет звучать именно так — можно ли это убрать.

3. Где лежат данные. Каталоги, базы, тома Docker, если есть. Что из этого нужно бэкапить, а что пересоздаётся.

4. Где секреты. Не сами пароли и ключи, а указание, где они хранятся: «токен бота в /etc/myapp/env, права 600». README читается чаще, чем нужно, и иногда не тем человеком.

5. Журнал изменений. Дата и одна строка. «Открыл порт для мониторинга», «перенёс бэкап с cron на systemd-таймер». Без подробностей, только чтобы было за что зацепиться.

Чтобы составить первую версию на уже работающей машине, не надо ничего вспоминать. Достаточно спросить у системы. Все команды ниже только читают, ничего не меняют:

systemctl list-units --type=service --state=running
systemctl list-timers
crontab -l
ls /etc/cron.d/
ss -tlnp
ls /etc/systemd/system/


Первая показывает работающие службы, вторая — таймеры systemd, которые многие забывают проверить, потому что ищут только в cron. ss -tlnp — какие порты слушаются и каким процессом. Последняя — юниты, которые добавлены руками, а не пришли с пакетами. Для crontab -l учтите, что у каждого пользователя свой, поэтому смотреть надо от того пользователя, под которым задачи создавались. Если Docker стоит, сюда же docker ps и список томов.

Каждую строку из этого вывода, которую вы не можете объяснить одной фразой, стоит разобрать до конца. Именно там обычно и живёт мой /opt/sync.

Две мелочи, которые помогают файлу не умереть.

Первая: напоминание при входе. В Debian и Ubuntu есть /etc/motd, его содержимое показывается после логина по SSH. Одна строка «Перед изменениями — /root/README.md» работает лучше, чем любые обещания себе. Правка требует root, но ничего не ломает.

Вторая: не глушить вывод скриптов в /dev/null. Если не хочется писем от cron, пусть пишет в файл, например:

0 4 * * * /opt/sync/run.sh >>/var/log/sync.log 2>&1


Это пример, путь подставьте свой и подумайте о ротации, если скрипт разговорчивый. Зато через год будет видно хотя бы дату последнего успешного запуска.

Правило обновления простое: изменил что-то на сервере — дописал строку в журнал до того, как закрыл SSH. Потом не допишется никогда.

Это не про большую инфраструктуру, там свои инструменты. Это про одну-две VPS, которые человек поднял для себя и не трогает месяцами. Интересно, кто как решает то же самое: держите заметки прямо на сервере или отдельно, в репозитории или менеджере паролей? У файла на сервере есть очевидный минус — он пропадёт вместе с машиной, и я пока не решил, насколько это критично.
0
andryukha
Junior
Сообщения: 97
Репутация: 78
Дата регистрации:
17.08.2026
01 нояб. 2026 г., 12:01 (GMT+3)

lexa92 писал:
Память — плохое хранилище: в ней нет поиска, нет истории, и она не переживает отпуск.


Я бы в этот README первой строкой вписал не «зачем», а «кто платит и до какого числа». Мёртвый скрипт в /dev/null хотя бы бесплатный: молчит и молчит. А сервер, про который помнишь только «там что-то с бэкапом», так же молча продлевается каждый месяц) Год такой забывчивости — двенадцать платежей за машину, которая чинит давно уехавший источник.
2
T
timur_ufa
Junior
Сообщения: 43
Репутация: 29
Дата регистрации:
01.09.2026
01 нояб. 2026 г., 14:00 (GMT+3)
ща, про «кто платит» прям в точку. у меня сервера пока нет, но с первой карты два месяца списывалось за приложение для заметок, которое я ставил ради одной лекции) заметок там ноль, то есть README у меня был пустой и платный. теперь в телефоне держу списочек: что, сколько, какого числа списание. если всё-таки возьму сервак под чатгпт с телефона, допишу его туда же, а не в память. она у меня до сессии живёт, дальше всё
-1
A
anna_edu
Junior
Сообщения: 20
Репутация: 7
Дата регистрации:
18.09.2026
01 нояб. 2026 г., 19:00 (GMT+3)

timur_ufa писал:
она у меня до сессии живёт, дальше всё


Это я каждый год вижу у учеников: конспект пишут к экзамену, а не себе через год. С материалами курса у меня было так же. Открываю прошлогоднюю папку, а там «итог_финал_2» и ни слова, почему вышел именно он. Теперь в каждой папке лежит короткая записка: что поменяла, зачем и что не сработало. Ваш списочек в телефоне — такая же записка, только про деньги. Хорошая привычка, держитесь её.
0
nesterov
Junior
Сообщения: 48
Репутация: 39
Дата регистрации:
08.08.2026
01 нояб. 2026 г., 20:11 (GMT+3)
«Что не сработало» в такой записке ценнее всего. И копию README держите не только на самом сервере. Умрёт диск, и письмо себе уйдёт вместе с ним.
2
Q
quiet_fox
Junior
Сообщения: 9
Репутация: 5
Дата регистрации:
30.09.2026
01 нояб. 2026 г., 21:00 (GMT+3)

anna_edu писал:
что поменяла, зачем и что не сработало


Добавить дату к каждой строке. Без даты «не сработало» через год читается как «не работает», хотя причину могли давно убрать.

nesterov, копия на стороне через полгода превращается во второе письмо, уже другое. Лучше держать README в git и пушить на другую машину. Тогда копия одна, а история правок идёт в комплекте.
2
D
dasha_voice
Junior
Сообщения: 33
Репутация: 10
Дата регистрации:
08.09.2026
02 нояб. 2026 г., 21:01 (GMT+3)

quiet_fox писал:
Без даты «не сработало» через год читается как «не работает»


В редакции это называется «цитата без даты»: человек сказал так в 2019-м, а мы подаём как сегодняшнее. С сервером для расшифровки у меня та же ловушка. В заметках висит «большая модель не влезла», и я уже не помню, на каком тарифе и с какой длиной записи. Так что к дате я бы дописывала условия: что было под рукой, когда не сработало. Иначе дата есть, а проверить нечего.
2
I
ivan_tver
Junior
Сообщения: 19
Репутация: 13
Дата регистрации:
14.09.2026
02 нояб. 2026 г., 23:03 (GMT+3)

dasha_voice писал:
к дате я бы дописывала условия


у меня в README висела строка «cursor через туннель не пускает», и больше ничего. открыл на днях и гадал: то ли ide режет регион, то ли ip сервера попал в чей-то список, то ли я тащил старую версию клиента. теперь пишу три поля: дата, версия клиента и с какого выхода шёл трафик. без версии такая запись протухает за месяц, ide обновляются чаще, чем я правлю README
0
lexa92
Middle
Сообщения: 166
Репутация: 146
Дата регистрации:
09.08.2026
03 нояб. 2026 г., 12:02 (GMT+3)

andryukha писал:
первой строкой вписал не «зачем», а «кто платит и до какого числа»


Строку вписал, но есть подвох. README читает тот, кто зашёл на сервер. На забытую машину как раз никто не заходит, она просто продлевается. Поэтому дата списания у меня теперь в двух местах: в README, чтобы понять, за что платишь, и в календаре с напоминанием за неделю. Первое объясняет, второе заставляет вообще открыть ssh.
0
tema_py
Junior
Сообщения: 94
Репутация: 76
Дата регистрации:
18.08.2026
03 нояб. 2026 г., 18:14 (GMT+3)

lexa92 писал:
дата списания у меня теперь в двух местах


Два места — это два письма, и через полгода они разъедутся. Продлил, поправил календарь, а README забыл. Или наоборот)

Я бы оставил одно место, а напоминалку сделал из него. Если README и так лежат в git на ноуте, как предлагали выше, пусть в каждом будет строка вида
paid_until: 2026-12-01
Дальше ща, десять строк:

import re, datetime, pathlib

root = pathlib.Path("~/servers").expanduser() # пример пути
for f in root.glob("*/README.md"):
m = re.search(r"^paid_until:\s*(\d{4}-\d{2}-\d{2})", f.read_text(), re.M)
if not m:
print(f.parent.name, "нет даты")
continue
left = (datetime.date.fromisoformat(m[1]) - datetime.date.today()).days
if left <= 7:
print(f.parent.name, m[1], f"осталось {left} дн.")


Запускать на своей машине, не на самом сервере: забытый сервер сам себе не напомнит. Вывод можно кинуть в бота или просто в cron с почтой.

Границы честные: скрипт знает только то, что ты вписал руками. Реальную дату списания он не проверяет, и если продлил и не обновил строку, будет врать. Зато строка «нет даты» хорошо ловит README, где про деньги вообще забыли написать 👍
2
A
anna_edu
Junior
Сообщения: 20
Репутация: 7
Дата регистрации:
18.09.2026
03 нояб. 2026 г., 19:02 (GMT+3)

tema_py писал:
Два места — это два письма, и через полгода они разъедутся.


Прошлой весной у меня так разъехалось расписание. В таблице курса вебинар стоял на четверг, а в чате группы висело старое «среда». Я поправила одно и забыла второе. В среду вечером мне написали трое учеников: «Анна, мы в комнате, а вас нет».

После этого я не стала держать дату в двух местах. Главным осталось одно место, таблица. В чате теперь только ссылка и фраза «актуальное время всегда здесь». Чат не знает дату, он только зовёт посмотреть.

Скрипт я не запущу, это не моё. Но по-моему, напоминание в календаре можно сделать таким же. Пусть в нём будет не сумма и не число списания, а одна строка: «открой README». Дата самого напоминания, конечно, всё равно дублируется. Поэтому у меня ещё и порядок, как в плане урока: сначала правлю главное, потом передвигаю напоминалку. Не наоборот.

quiet_fox, ваша дата к каждой строке тут тоже помогла. Открываю старую записку «ссылка на запись не открывается», а рядом март. Сразу понятно, что это было до переезда материалов и сегодня ни о чём не говорит.
0
lexa92
Middle
Сообщения: 166
Репутация: 146
Дата регистрации:
09.08.2026
04 нояб. 2026 г., 18:07 (GMT+3)

tema_py писал:
Два места — это два письма, и через полгода они разъедутся.


Принимаю. Календарь в моей схеме молчит, когда разъезжается. Продлил, забыл передвинуть, и он напомнит про дату, которой уже нет. Или не напомнит, если сдвинул только его.

У твоего скрипта это поведение лучше, чем ты сам написал. Условие left <= 7 пропускает отрицательные значения. Если продлил и не обновил строку, после старой даты он будет каждый день печатать «осталось -3 дн.». Это либо сервер действительно отвалился, либо README врёт. В обоих случаях надо идти и смотреть, так что расхождение не тихое, оно орёт, пока его не исправишь. Календарь так не умеет, его можно удалить.

Две поправки по эксплуатации. Первая: в README рядом с датой одна строка, где эту дату проверить, то есть в какой панели и под каким аккаунтом. Тогда «-3 дн.» сразу ведёт к источнику, а не к гаданию. Вторая про cron на ноуте: он не запустится, если ноут в это время закрыт. Если ноут на Linux с systemd, таймер с Persistent=true догонит пропущенный запуск при включении. На другой системе нужен свой аналог, тут я не знаю, что у кого.

Календарь сегодня вечером снёс. Остаётся одно место и один скрипт, который не даёт ему соврать молча.
0
nesterov
Junior
Сообщения: 48
Репутация: 39
Дата регистрации:
08.08.2026
04 нояб. 2026 г., 19:00 (GMT+3)
quiet_fox, с git согласен: копия одна, и история правок при ней. Одна оговорка. В README серверов любят вписывать пароль от панели или токен, «чтобы не искать». В git он останется в истории, даже если строку потом стереть, и уедет на ту машину, куда пушите. Поэтому в README лучше писать, где лежит секрет, а не сам секрет. И иногда смотреть git log на той стороне: копия, в которую не пушили с весны, ничем не лучше второго письма.
1
D
dasha_voice
Junior
Сообщения: 33
Репутация: 10
Дата регистрации:
08.09.2026
04 нояб. 2026 г., 21:00 (GMT+3)

ivan_tver писал:
без версии такая запись протухает за месяц


У меня в заметках с весны висит: «модель путает фамилии, не брать». Какую версию я тогда гоняла, не записано, а обновлялась я с тех пор дважды. И полгода честно обходила её стороной. Журналист, который поверил непроверенной цитате, причём своей же.

Теперь пишу версию модели и какую запись давала: час в шумном кафе и спокойный голос по телефону — это два разных теста.
1
Q
quiet_fox
Junior
Сообщения: 9
Репутация: 5
Дата регистрации:
30.09.2026
04 нояб. 2026 г., 21:06 (GMT+3)
Напоминалку можно сделать повторяющейся: раз в месяц «открой README». Тогда двигать нечего. Моя такая висит давно, открываю через раз. Зато она не врёт.
0