[{"_1":2,"_153":-5,"_154":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_132":133},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11,"_20":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_84":-5,"_85":86,"_125":-5,"_126":11,"_127":17,"_128":11,"_129":-5,"_130":131},"canonicalUrl","https://hub.docker.com/r/alexd1971/doc_gen/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","alexd1971","reponame","doc_gen","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":70,"_75":11,"_76":77,"_81":29,"_82":83},"categories",[],"content_types",[40],"image","date_registered","2019-06-14T10:11:59.508721Z","description","Сервис генерации документов","is_private","last_updated","2019-06-14T10:21:22.7355Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",77,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Сервис генерации документов\n\nСервис позволяет сгенерировать документы в html- и pdf-формате на основе pug-шаблона\n\n## Запуск сервиса\n\nДля генерации pdf сервис использует браузер Chrome, запущенный в headless режиме. Для запуска Chrome можно воспользоваться, например, [docker-образом](https://hub.docker.com/r/ttonyh/chrome-headless-stable)\n\nДля запуска сервиса в автономном режиме проще всего использовать docker-compose.\n\ndocker-compose.yml:\n```yaml\nversion: \"3\"\nservices: \n chrome:\n image: ttonyh/chrome-headless-stable\n container_name: chrome\n networks:\n - net\n html2pdf:\n image: alexd1971/doc_gen\n container_name: doc-gen\n depends_on: \n - chrome\n networks: \n - net\n ports:\n - 7777:7777\n volumes:\n - ./config.json:/app/config.json\n - ./path/to/templates:/app/templates\nnetworks:\n net:\n driver: bridge\n```\n\nСервис может быть легко интегрирован в любое приложение с микросервисной архитектурой. Организация запуска должна быть выполнена таким образом, чтобы было возможно необходимое сетевое взаимодействие между микросервисами приложения.\n\n## Шаблоны\n\nНа данный момент допускаются только шаблоны в формате шаблонизатора [pug](https://pugjs.org).\n\nСами шаблоны необходимо размещить в каталоге `templates`, выделяя для шаблона каждого документа отделный каталог. Главный файл шаблона должен иметь имя index.pug. Имя документа для генерации pdf-файла определяется именем каталога с файлом index.pug.\n\nПоскольку шаблон документа читается непосредственно перед генерацией pdf-документа, шаблоны можно закгружать в каталог шаблонов как вручную, так и посредством внешнего приложения без необходимости перезапуска сервиса.\n\n## Генерация pdf-документа\n\nДля генерации pdf-документа необходимо отправить сервису `POST`-запрос следующего формата:\n\n```\nContent-Type: application/json\n```\n```json\n{\n \"template\": \"document_name\",\n \"vars\": {\n \"title\": \"Заголовок документа\",\n \"value\": \"значение какого-либо поля документа\",\n ...\n },\n \"outputFormat\": \"pdf\",\n \"printOptions\": {\n \"pageRanges\": \"1\",\n }\n}\n```\n\n`template` (обязательный параметр) - содержит имя катлога шаблона с файлом `index.pug`\n\n`vars` - значения переменных шаблона (не обязательно)\n\n`outputFormat` - формат возвращаемого документа; допустимы варианты: `pdf`, `html`\n\n`printOptions` - парамтеры печати для pdf-документа (не обязательно)\n\nДопустимые `printOptions`:\n\n* `landscape`: boolean\n* `marginTop`: num\n* `marginBottom`: num\n* `marginLeft`: num\n* `marginRight`: num\n* `includeBackground`: boolean\n* `paperWidth`: num\n* `paperHeight`: num\n* `pageRanges`: string (Например: `\"1\"` или `\"2-4,6-8\"`)\n* `scale`: num (диапазон допустимых значений: 0.1 - 2)\n* `displayHeaderFooter`: boolean\n* `headerTemplate`: string (html-шаблон)\n* `footerTemplate`: string (html-шаблон)\n\nПри создании html-шаблонов `headerTemplate` и `footerTemplate` можно использовать следующие предопределённые классы:\n\n* `date` (дата формирования документа)\n* `title` (title html-документа)\n* `url` (размещение документа)\n* `pageNumber` (номаер текущей страницы)\n* `totalPages` (всего страниц)\n\nТак же нужно учитывать, что к шаблонам `headerTemplate` и `footerTemplate` применяются следующие стили:\n\n```css\n\n```\n\nПри этом то, что прописано в `headerTemplate` автоматически оборачивается в\n\n```html\n\n```\n\nАналогино то, что прописано в `footerTemplate` автоматически оборачивается в\n\n```html\n\n```\n\nПример шаблона:\n\n```html\n

\n Page of \n

\n```\nВ случае успешной генерации документа сервис отвечает:\n\n* для pdf-документа:\n\n```\nHTTP 200 OK\nContent-type: application/pdf\n```\n\n* для html-документа:\n\n```\nHTTP 200 OK\nContent-type: text/html\n```\n\nВ теле ответа находится содержимое документа, которое можно сохранить на диск или передать дальше.\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",40189143,"orgData","recentTags",[87],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":96,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},"content_type","creator",651627,"full_size",32962805,"id",58896079,"images",[97],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},"architecture","amd64","digest","sha256:a7dd43ba9db7a37a7576bcdcff74d8942df606fa70bcc2bacc43b7d655d939b0","features","","last_pulled","2026-09-15T07:06:47.251437169Z","last_pushed","2019-06-14T10:21:23Z","os","linux","os_features","os_version","size","variant","2019-06-14T10:21:22.293905Z","last_updater","last_updater_username","media_type","latest","repository",7264636,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":134,"_141":142,"_130":151,"_152":11},{"_36":135,"_38":136,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":137,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":58,"_65":66,"_67":11,"_68":29,"_69":138,"_75":11,"_76":140,"_81":29,"_82":83},[],[40],[52],{"_71":11,"_72":139},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_143":60,"_144":-5,"_145":-5,"_146":147},"count","next","previous","results",[148],{"_88":40,"_89":90,"_91":92,"_93":94,"_95":149,"_46":114,"_115":90,"_116":29,"_117":52,"_53":118,"_119":120,"_121":105,"_122":114,"_123":62,"_124":17},[150],{"_98":99,"_100":101,"_102":103,"_104":105,"_106":107,"_108":109,"_110":103,"_111":-5,"_112":92,"_59":62,"_113":-5},[],"canDeleteTags","actionData","errors"]

alexd1971/doc_gen

Tags for alexd1971/doc_gen