About so-novel

So Novel is a versatile web content processing and export tool designed to efficiently extract structured information from websites and convert it into standard electronic document formats such as EPUB, TXT, and PDF. It serves users with needs for learning data collection, format conversion, and e-book production. The software offers flexible deployment options including a Text-based User Interface, a Web User Interface, and a Command Line Interface. It supports installation on multiple platforms via direct download, package managers like Scoop and Homebrew, native Linux scripts, and Docker containers. Docker deployment is highly flexible, supporting one-click scripts, Docker Compose configurations, direct container execution with volume mounting for configuration and downloads, and building custom images from source. The tool is open-source and designed to handle various web publishing scenarios to create portable digital libraries.

f

Published by

freeok

Visit View Profile

README.md

View on GitHub

So Novel

概述

So Novel 是一款通用的网页内容处理与导出工具，它致力于帮助用户高效地从网页中提取结构化信息，并将其灵活导出为 EPUB、TXT、PDF 等多种标准电子文档格式。适用于学习采集、格式转换、电子书制作等场景。

预览

点击查看图片

TUI 预览 (Text-based User Interface)

WebUI 预览 (网页版)

CLI 预览 (Command Line Interface)

使用

📦 普通安装

下载最新版 https://github.com/freeok/so-novel/releases
根据 readme.txt 使用

🍨 Scoop

scoop bucket add freeok https://github.com/freeok/scoop-bucket
scoop install freeok/so-novel

🍺 Homebrew

brew tap ownia/homebrew-ownia
brew install so-novel

🐧 Linux

bash <(curl -sSL https://raw.githubusercontent.com/freeok/so-novel/main/bin/linux-install.sh)

🐳 Docker

方式 1：脚本一键安装

curl -sSL https://raw.githubusercontent.com/freeok/so-novel/main/bin/docker-install.sh | bash

方式 2：Docker Compose

services:
  sonovel:
    image: ghcr.io/freeok/sonovel:latest
    container_name: sonovel
    ports:
      - "7765:7765"
    environment:
      JAVA_OPTS: "-Dmode=web"
    volumes:
      - sonovel_data:/sonovel
    restart: unless-stopped

volumes:
  sonovel_data:

方式 3：直接运行容器

# 如需挂载，请提前准备好 config.ini 文件、rules 目录
docker run -d \
  --name sonovel \
  -v /sonovel/config.ini:/sonovel/config.ini \
  -v /sonovel/rules:/sonovel/rules \
  -v /sonovel/downloads:/sonovel/downloads \
  -p 7765:7765 \
  -e JAVA_OPTS='-Dmode=web' \
  ghcr.io/freeok/sonovel:latest

方式 4：从源码构建镜像

# 确保已安装 git、maven
# arch: [x64|arm64]

# 构建项目
git clone https://github.com/freeok/so-novel.git && cd so-novel
sh bin/release-linux.sh [arch]

# 构建 Docker 镜像
cp -r target/sonovel-linux_[arch]/{app.jar,config.ini,rules} .
docker build -t sonovel .

[!TIP]

为获得最佳阅读体验，建议使用以下电子书阅读器：

桌面端

Readest

Koodo Reader

Calibre

Neat Reader（网页版）

移动端

Readest

Apple Books

Moon+ Reader（静读天下）

Kindle

如需转换为其它电子书格式，可使用：

FreeConvert

Calibre

修复 WPS、掌阅等软件无法打开 so-novel 下载的 EPUB：https://github.com/freeok/so-novel/discussions/199

自定义 JVM 系统属性

参数	说明	默认值
-Dconfig.file	配置文件路径	./config.ini
-Dmode	启动模式，可选值：tui\|cli\|web	tui

用法

[!NOTE]

Windows 修改 sonovel.l4j.ini

Linux 修改 run-linux.sh

macOS 修改 run-macos.sh

使用本地 JDK / JRE 启动

如果你不想使用内置 JRE（runtime 目录），可以通过本地 JDK / JRE 启动程序

Windows 使用脚本 start-custom-jre.cmd：

REM --------------------------------------------------
REM 高级用户使用自定义 JRE 启动程序
REM 将 "your_path\java.exe" 替换为你的 JRE 路径，例如：
REM "C:\Java\jdk-21\bin\java.exe"
REM --------------------------------------------------
@echo off
your_path\java.exe ^
  -XX:+UseZGC ^
  -XX:+ZGenerational ^
  -Dconfig.file=config.ini ^
  -Dmode=tui ^
  -Dfile.encoding=GBK|Big5 ^
  -jar app.jar

Linux / macOS：run-linux.sh / run-macos.sh 修改 java 路径