From 849102b4fe546c27633e67e5648519d225e1a9e1 Mon Sep 17 00:00:00 2001 From: Iosif Pravets Date: Fri, 25 Jul 2025 10:56:36 +0000 Subject: [PATCH] =?UTF-8?q?docs:=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82=D0=B0?= =?UTF-8?q?=D1=86=D0=B8=D1=8F=20=D0=BF=D0=BE=20=D0=BE=D0=B1=D1=80=D0=B0?= =?UTF-8?q?=D0=B7=D1=83=20winow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 07d4604..7c3a2dd 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ - [oscript](#oscript) - [yard](#yard) - [onec-installer-downloader](#onec-installer-downloader) +- [winow](#winow) ## Подготовительные шаги @@ -201,4 +202,55 @@ sleemp/onec-installer-downloader:20250723 thin-client32 8.3.25.1445 Ограничения аналогичны [базовому образу](#yard) -[↑ В начало](#oscript-images) \ No newline at end of file +[↑ В начало](#oscript-images) + +## winow + +[![Docker Pulls](https://img.shields.io/docker/pulls/sleemp/winow)](https://hub.docker.com/r/sleemp/winow) + +Готовые собранные образы можно взять в [sleemp/winow](https://hub.docker.com/r/sleemp/winow) + +### Назначение + +Образ предназначен для запуска веб-приложений на фреймворке [winow](https://github.com/autumn-library/winow). + +### Сборка + +1. [**Выполните подготовительные шаги**](#подготовительные-шаги), если не сделали это ранее + +1. **Добавьте тег `winow`** + - Перейдите во вкладку "Tags" или используйте команду: + ```bash + git tag winow + git push origin winow + ``` + + - либо клонируйте репозиторий к себе на Linux-хост (или используйте GitHub Codespaces) и запустите скрипт `./src/tag-winow-latest.sh` — он принудительно «перевесит» тег на последний коммит и запушит теги + - Это необходимо для запуска сборки yard через GitHub Actions. + +1. **Запустите сборку** + - После пуша тега workflow автоматически соберёт и опубликует образ `winow` в ваш Docker Registry. + - будет опубликован образ с тегом `latest`, а также с номерной версией собранного `winow` + +1. **Проверьте результат** + - Убедитесь, что образ появился в вашем Docker Registry с именем `winow` и соответствующей версией. + +### Зависимости + +Образ собирается на основе [oscript:dev](#oscript), он должен быть предварительно собран и запушен. + +### Использование + +1. Есть два варианта использования образа - для запуска как есть и для сборки на его основе образа вашего приложения + +1. В любом случае, необходимо добавить в контейнер каталог c вашим приложением. Для запуска как есть используйте ключ `-v ./app:/app`. + +1. Также необходимо пробросить из контейнера порт `3333`, например так `-p 8080:3333` + +1. В образе реализована возможность при запуске доустанавливать зависимости вашего приложения с помощью ключа `-deps`. Но нужно помнить, что "прибитые молотком" версии пакетов `autumn`, `winow`, `winow-cli` и их зависимостей могут привести к непредсказуемым последствиям. + +### Ограничения + +1. Явных ограничений вроде бы нет. + +[↑ В начало](#oscript-images)