From e31cb3418bd943086bd5b567f281bf4d1fc2dd81 Mon Sep 17 00:00:00 2001 From: Sudo-Ivan Date: Wed, 1 Oct 2025 03:02:14 -0500 Subject: [PATCH] Update --- README.md | 2 ++ README.ru.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 94 insertions(+) create mode 100644 README.ru.md diff --git a/README.md b/README.md index 19942ea..bcdf7b7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # RNS Page Node +[Русская](README.ru.md) + [![Build and Publish Docker Image](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker.yml/badge.svg)](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker.yml) [![Docker Build Test](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker-test.yml/badge.svg)](https://github.com/Sudo-Ivan/rns-page-node/actions/workflows/docker-test.yml) [![DeepSource](https://app.deepsource.com/gh/Sudo-Ivan/rns-page-node.svg/?label=active+issues&show_trend=true&token=kajzd0SjJXSzkuN3z3kG9gQw)](https://app.deepsource.com/gh/Sudo-Ivan/rns-page-node/) diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..7a7640d --- /dev/null +++ b/README.ru.md @@ -0,0 +1,92 @@ +# RNS Page Node + +Простой способ для раздачи страниц и файлов через сеть [Reticulum](https://reticulum.network/). Прямая замена для узлов [NomadNet](https://github.com/markqvist/NomadNet), которые в основном служат для раздачи страниц и файлов. + +## Использование + +```bash +# Pip +# Может потребоваться --break-system-packages + +pip install rns-page-node + +# Pipx + +pipx install rns-page-node + +# uv + +uv pip install rns-page-node + +# Git + +pipx install git+https://github.com/Sudo-Ivan/rns-page-node.git +``` + +```bash +# будет использовать текущий каталог для страниц и файлов +rns-page-node +``` + +## Использование + +```bash +rns-page-node --node-name "Page Node" --pages-dir ./pages --files-dir ./files --identity-dir ./node-config --announce-interval 360 +``` + +### Docker/Podman + +```bash +docker run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/root/.reticulum ghcr.io/sudo-ivan/rns-page-node:latest +``` + +### Docker/Podman без root + +```bash +mkdir -p ./pages ./files ./node-config ./config +chown -R 1000:1000 ./pages ./files ./node-config ./config +podman run -it --rm -v ./pages:/app/pages -v ./files:/app/files -v ./node-config:/app/node-config -v ./config:/app/config ghcr.io/sudo-ivan/rns-page-node:latest-rootless +``` + +Монтирование томов необязательно, вы также можете скопировать страницы и файлы в контейнер с помощью `podman cp` или `docker cp`. + +## Сборка + +```bash +make build +``` + +Сборка wheels: + +```bash +make wheel +``` + +### Сборка Wheels в Docker + +```bash +make docker-wheels +``` + +## Страницы + +Поддерживаются динамические страницы, но парсинг данных запроса пока не реализован. + +## Опции + +``` +-c, --config: Путь к файлу конфигурации Reticulum. +-n, --node-name: Имя узла. +-p, --pages-dir: Каталог для раздачи страниц. +-f, --files-dir: Каталог для раздачи файлов. +-i, --identity-dir: Каталог для сохранения идентификационных данных узла. +-a, --announce-interval: Интервал анонсирования присутствия узла. +-r, --page-refresh-interval: Интервал обновления страниц. +-f, --file-refresh-interval: Интервал обновления файлов. +-l, --log-level: Уровень логирования. +``` + +## Лицензия + +Этот проект включает части кодовой базы [NomadNet](https://github.com/markqvist/NomadNet), которая лицензирована под GNU General Public License v3.0 (GPL-3.0). Как производная работа, этот проект также распространяется на условиях GPL-3.0. Полный текст лицензии смотрите в файле [LICENSE](LICENSE). +