upd README + docs

This commit is contained in:
Dmitry Belyaev 2024-02-25 23:00:34 +03:00
parent 51f5ed26db
commit 78cf337edf
Signed by: b4tman
GPG Key ID: 41A00BF15EA7E5F3
2 changed files with 32 additions and 8 deletions

View File

@ -2,13 +2,23 @@
Возможно `DDNS` клиент Возможно `DDNS` клиент
## запуск ## Запуск
~~~sh ~~~sh
python -m pddnsc.cli python -m pddnsc.cli
~~~ ~~~
## конфигурация либо в [docker](https://www.docker.com)/[podman](https://podman.io) (для запуска по расписанию в `cron`):
~~~bash
docker build -t my/pddnsc .
docker run -v .state:/app/state:rw \
-v .settings:/app/settings:ro \
-e SCHEDULE=@hourly \
my/pddnsc
~~~
## Конфигурация
Конфигурация находится в файле `settings/config.toml`. Конфигурация находится в файле `settings/config.toml`.
Пример конфигурации: Пример конфигурации:
@ -27,7 +37,7 @@ python -m pddnsc.cli
filepath = "state/hash.txt" filepath = "state/hash.txt"
[outputs] [outputs]
# сохранение хеша всех ip адресов в файл, # сохранение хеша всех ip адресов в файл,
# чтобы потом проверить изменились ли они # чтобы потом проверить изменились ли они
[outputs.hash-file] [outputs.hash-file]
provider = "StateHashFile" provider = "StateHashFile"
@ -36,7 +46,7 @@ python -m pddnsc.cli
# сервис доменов на vscale (vds.selectel.ru) # сервис доменов на vscale (vds.selectel.ru)
# токен в переменной окружения VSCALE_API_TOKEN # токен в переменной окружения VSCALE_API_TOKEN
[outputs.vscale] [outputs.vscale]
provider = "VscaleDomains" provider = "VscaleDomains"
domain = "example.com" domain = "example.com"
target = "www" # изменяем www.example.com target = "www" # изменяем www.example.com
ttl = 3600 ttl = 3600
@ -52,6 +62,20 @@ python -m pddnsc.cli
Все модули источников/фильтров/вывода работают конкурентно через `asyncio`. Все модули источников/фильтров/вывода работают конкурентно через `asyncio`.
### TODO ### Подробная документация
- Добавить названия python классов и их параметры. Её необходимо собрать с помошью [mkdocs](https://www.mkdocs.org). Для этого нужно установить зависимости:
~~~bash
pip install -r requirements.txt
pip install -r requirements.docs.txt
~~~
После этого либо собрать документацию в каталог `site/`, либо запустить тестовый сервер.
~~~bash
# сборка
mkdocs build
# тестовый сервер
mkdocs serve
~~~

View File

@ -20,5 +20,5 @@ plugins:
config: mkapi_conf.py config: mkapi_conf.py
nav: nav:
- Home: index.md - Главная: index.md
- Reference: $api/pddnsc.*** - Справочник: $api/pddnsc.***