Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ability to run in docker #23

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
FROM node:20-alpine as build

WORKDIR /app
ENV PATH /app/node_modules/.bin:$PATH
COPY .babelrc .eslintrc nodemon.json package-lock.json package.json README.md ./
COPY build ./build/
COPY client ./client/
COPY server ./server/

RUN apk add zip
RUN npm install
RUN npm run build:client
RUN node build/prepkg.js linux
RUN pkg -t node18-linux-x64 -C Brotli --options max-old-space-size=4096,expose-gc -o dist/linux/inpx-web .

# Build the prod image
FROM alpine:latest

# Move to /dist directory as the place for resulting binary folder
WORKDIR /app
RUN apk add libgcc libstdc++ gcompat curl
RUN mkdir -m 0777 data
COPY docker_entrypoint.sh entrypoint.sh
COPY --from=build /app/dist/linux/inpx-web .

EXPOSE 12380

HEALTHCHECK CMD curl --fail http://localhost:12380 || exit 1

ENTRYPOINT [ "/app/entrypoint.sh" ]
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opd

[Отблагодарить автора проекта](https://donatty.com/liberama)

##
##
* [Возможности программы](#capabilities)
* [Использование](#usage)
Expand All @@ -32,6 +33,7 @@ OPDS-сервер доступен по адресу [http://127.0.0.1:12380/opd
* [Сборка релизов](#build)
* [Запуск без сборки релиза](#native_run)
* [Разработка](#development)
* [Запуск в docker](#docker)

<a id="capabilities" />

Expand Down Expand Up @@ -110,7 +112,7 @@ Options:
// пустая строка: использовать значение по умолчанию - inpx-файл, что найдется в директории библиотеки
"inpx": "",

// конфигурационный файл для фильра по авторам и книгам (см. ниже)
// конфигурационный файл для фильтра по авторам и книгам (см. ниже)
// пустая строка: использовать значение по умолчанию - файл filter.json в директории файла конфигурации
"inpxFilterFile": "",

Expand Down Expand Up @@ -410,4 +412,22 @@ node server --app-dir=.inpx-web
npm run dev
```

<a id="docker" />

### Запуск в docker

Сборка:
```sh
docker build -t inpx-web .
```

Запуск:
```sh
docker run -v /path/to/library:/library:ro --user=1000 -p 12380:12380 inpx-web
```

- В этом случае база данных и конфигурация будут пересоздаваться при каждом запуске. Для того, что сделать конфигурацию персистентной примонтируйте каталог в /app/data добавлением параметра в docker run: `-v /path/to/app_data:/app_data`
- Использование индекса, находящегося не в директории с библиотекой - передайте в docker run: `-v /path/to/index/flibusta.inpx:/app/index.inpx:ro -e INDEX_FILE=/app/index.inpx`
- Если используется персистентная конфигурация (см выше), но нужно перечитывать индекс при каждом запуске передайте в docker run: `-e RECREATE=1`

Связаться с автором проекта: [bookpauk@gmail.com](mailto:bookpauk@gmail.com)
11 changes: 11 additions & 0 deletions docker_entrypoint.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#!/bin/sh

set -e

OPTS="--lib-dir=/library --app-dir=/app/data"

[ -z ${INDEX_FILE+x} ] || OPTS="$OPTS --inpx=\"${INDEX_FILE}\""
[ -z ${RECREATE+x} ] || OPTS="$OPTS --recreate"

echo Starting ./inpx-web $OPTS
./inpx-web $OPTS
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "inpx-web",
"version": "1.5.7",
"version": "1.5.8",
"author": "Book Pauk <bookpauk@gmail.com>",
"license": "CC0-1.0",
"repository": "bookpauk/inpx-web",
Expand Down
9 changes: 5 additions & 4 deletions server/config/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ class ConfigManager {
return instance;
}

async init(tempDataDir, configFile) {
async init(defaultDataDir, configFile) {
if (this.inited)
throw new Error('already inited');

Expand All @@ -69,14 +69,15 @@ class ConfigManager {
this.branchConfigFile = __dirname + `/${this.branch}.js`;
const config = require(this.branchConfigFile);

if (!tempDataDir) {
tempDataDir = `${config.execDir}/.${config.name}`;
if (!defaultDataDir) {
defaultDataDir = `${config.execDir}/.${config.name}`;
}

if (configFile) {
config.configFile = path.resolve(configFile);
} else {
config.configFile = `${tempDataDir}/config.json`;
await fs.ensureDir(defaultDataDir);
config.configFile = `${defaultDataDir}/config.json`;
}

this._config = config;
Expand Down