From 7fa203eaae24479f96fe1aed08dc508670643e43 Mon Sep 17 00:00:00 2001 From: Book Pauk Date: Thu, 24 Nov 2022 20:50:04 +0700 Subject: [PATCH] =?UTF-8?q?=D0=9F=D0=BE=D0=BF=D1=80=D0=B0=D0=B2=D0=BB?= =?UTF-8?q?=D0=B5=D0=BD=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 56cb118..130f0e4 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ inpx-web или [LightLib](https://lightlib.azurewebsites.net) [Установка](#usage): просто поместить приложение `inpx-web` в папку с .inpx-файлом и файлами библиотеки (zip-архивами) и запустить. -По умолчанию, сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380) + +По умолчанию, веб-сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380) + +OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opds](http://127.0.0.1:12380/opds) Для указания местоположения .inpx-файла или папки с файлами библиотеки, воспользуйтесь [параметрами командной строки](#cli). Дополнительные параметры сервера настраиваются в [конфигурационном файле](#config). @@ -30,6 +33,7 @@ inpx-web ## Возможности программы +- веб-интерфейс и OPDS-сервер - поиск по автору, серии, названию и пр. - скачивание книги, копирование ссылки или открытие в читалке - возможность указать рабочий каталог при запуске, а также расположение .inpx и файлов библиотеки @@ -47,7 +51,9 @@ inpx-web Там же, при первом запуске, будет создана рабочая директория `.inpx-web`, в которой хранится конфигурационный файл `config.json`, файлы базы данных, журналы и прочее. -По умолчанию сервер будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380) +По умолчанию веб-интерфейс будет доступен по адресу [http://127.0.0.1:12380](http://127.0.0.1:12380) + +OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opds](http://127.0.0.1:12380/opds) @@ -131,6 +137,14 @@ Options: "server": { "host": "0.0.0.0", "port": "12380" + }, + + // настройки opds-сервера + // user, password используются для Basic HTTP authentication + "opds": { + "enabled": true, + "user": "", + "password": "" } } ``` @@ -266,17 +280,12 @@ cd inpx-web npm i ``` -#### Для платформы Windows +#### Релизы ```sh -npm run build:win +npm run release ``` -#### Для платформы Linux -```sh -npm run build:linux -``` - -Результат сборки будет доступен в каталоге `dist/linux|win` в виде исполнимого (standalone) файла. +Результат сборки будет доступен в каталоге `dist/release`