ebat obnova

README.md

@@ -1,48 +1,81 @@
-## debweb
+# debweb
 
 **debweb** - простой webserver для дебилов (for me) на асинхронных сокетах
 
-## установка и настройка
+# установка и настройка
 
 debweb использует всего одну стороннюю библиотеку - aiofiles. ее можно установить с помощью
 
 ```bash
 pip install aiofiles
 ```
-> [!IMPORTANT]
+
 конфигурация сия шедевра происходит в файле `config.py`
 
-### основное
+## основное
 
 - `name` - название сервера, отображается в http заголовках
+- `proxied` - указывает, находится ли сервер за прокси
 
-### сеть
+## сеть
 
 - `addr` - адрес сервера
 - `port` - порт сервера
 
-### файлы и директории
+## файлы и директории
 
 - `log_file` - файл логов (по умолчанию вывод в консоль)
-- `preset_file` - файл пресета. обычный html документ. но в нем нужно указать одиночный тег `<FILES>` для отображения файлов в директории
-- `directory` - рабочая директория **обязательно с / на конце!!!!**
+- `preset_file` - файл пресета
+- `directory` - рабочая директория
 
-### буферы
+## буферы
 
-- `read_buffer` - буфер для запроса
+- `read_buffer` - размер буфера для запросов
 - `write_buffer` - размер буфера при отправке файлов
 
-### логи
+## логи
 
 - `start_msg` - лог при старте сервера
 - `conn_msg` - лог при подключении
 - `get_msg` - лог при GET запросе
 
-`<ADDR>` будет заменен на адрес клиента
+## теги
 
-`<FILE>` будет заменен на файл / директорию, к которой запрашивается доступ
+- `<ADDR>` - адрес клиента
+- `<FILE>` - файл / директория, к которой запрашивается доступ
 
-### ошибки
+## шаблоны
 
-- `e404_file` - html файл, который будет отправлен при ошибке 404
-- `e404_msg` - лог при ошибке 404
+- `file_entry` - шаблон для генерации строк файлов в листинге директории
+- `dir_entry` - шаблон для генерации строк каталогов в листинге директории
+- `time_format` - формат времени для всего документа
+
+### теги шаблонов
+
+- `<NAME>` - название элемента
+- `<REL_PATH>` - относительный путь элемента
+- `<CDATE>` - дата создания элемент
+- `<MDATE>` - дата модификации элемента
+- `<SIZE_B>` - размер файла в байтах
+- `<SIZE_KB>` - размер файла в килобайтах
+- `<SIZE_MB>` - размер файла в мегабайтах
+- все остальные html теги
+
+## preset.html
+
+обычный html документ, являющийся шаблоном для листинга каталога
+
+### теги пресета
+
+- `<FILES>` -  отображает все элементы директории
+- `<FILE_COUNT>` - количество файлов
+- `<DIR_COUNT>` - количество подкаталогов
+- `<TOTAL_COUNT>` - общее количество элементов
+- `<SERVER>` - название сервера
+- `<LOAD_TIME>` - время обработки страницы
+- `<SERVER_TIME>` - время на сервере
+
+## ошибки
+
+- `err_Files` - словарь с кодами ошибок и файлами, которые отправляются при этих ошибках
+- `err_msgs` - словарь с кодами ошибок и логами, которые отправляются при этих ошибках