Standard Ebooks Toolset

To install the toolset on Ubuntu, you must have Python >= 3.10.12. The installation process differs slightly between Ubuntu 24.04 (Noble) and 20.04 (Focal).

Ubuntu 24.04 (Noble)

Install pre-flight dependencies and the toolset using pipx:

# Install some pre-flight dependencies.
sudo apt install --yes default-jre git python3-dev python3-pip python3-venv pipx

# Install the toolset.
pipx install standardebooks

Ubuntu 20.04 (Focal)

Install pre-flight dependencies, then install and configure pipx before installing the toolset:

# Install some pre-flight dependencies.
sudo apt install --yes default-jre git python3-dev python3-pip python3-venv

# Install pipx.
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install the toolset.
pipx install --python=3.12 --fetch-missing-python standardebooks

Install the required dependencies via dnf, ensure your pipx path is configured, and then install the toolset.

# Install some pre-flight dependencies.
sudo dnf install pipx python3-devel gcc libxslt-devel git java-25-openjdk-headless

# Ensure $PATH environment variable is correctly set up for pipx.
pipx ensurepath

# Install the toolset.
pipx install standardebooks

EPUBCheck can be run as a standalone CLI tool to check EPUB publications for conformance. You must have a Java runtime (version 1.7 or above) installed on your system. Detected errors are printed to the standard error stream.

java -jar epubcheck.jar file.epub

You can run the checker as a self-contained HTTP service using a built-in Jetty server. This allows for browser-based checking of HTML, CSS, and SVG files.

To start the server, invoke the nu.validator.servlet.Main class with a port number. By default, it listens on all interfaces (0.0.0.0), but future releases may default to 127.0.0.1. To ensure accessibility on a specific network interface, use the nu.validator.servlet.bind-address system property.

If you encounter a StackOverflowError, increase the thread stack size using the -Xss Java option.

Install dependencies via WinGet in PowerShell, then use pipx to install the toolset.

1. Install dependencies:

   winget install --exact --id Python.Python.3.12
   winget install --exact --id Git.Git
   winget install --exact --id Microsoft.OpenJDK.21
   winget install --exact --id tschoonj.GTKForWindows

2. Restart PowerShell, then install and configure pipx:

   py -3.12 -m pip install --user pipx
   py -3.12 -m pipx ensurepath

3. Restart PowerShell and install the toolset:

   pipx install --python 3.12 standardebooks

To build, test, and run the Nu Html Checker so that the Web UI is accessible at http://0.0.0.0:8888/, follow these steps:

1. Ensure git, python, and JDK 8 or above are installed.
2. Set the JAVA_HOME environment variable:
   • Ubuntu/Linux: export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 (adjust path as needed).
   • MacOS: export JAVA_HOME=$(/usr/libexec/java_home)
3. Clone the repository: git clone https://github.com/validator/validator.git
4. Enter the directory: cd validator
5. Run the checker script: python ./checker.py all

Note: The first run requires an internet connection to download several megabytes of dependencies.

The recommended method is using Homebrew. Alternatively, you can use pipx for a more granular installation.

Using Homebrew

1. Update Homebrew:

   brew update

2. Install the tools:

   brew install standardebooks

Using pipx (Alternative)

Install dependencies manually and then use pipx:

# Install some pre-flight dependencies.
brew install cairo git openjdk pipx python@3.12
pipx ensurepath
sudo ln -sfn $(brew --prefix)/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

# Install the toolset.
pipx install --python "$(brew --prefix)"/bin/python3.12 standardebooks

Note on SVG rendering: If you are building projects with SVG images and do not have Chrome or Firefox installed, you must manually enable Safari:

safaridriver --enable

If you are developing the toolset, install it in "editable" mode using pipx. This allows changes to the source code to take effect immediately without re-installation.

git clone https://github.com/standardebooks/tools.git
pipx install --editable ./tools

After installation, the se binary will be available in your path, reflecting any edits made to the files in the tools/ directory.

To run the checker within an existing servlet container like Apache Tomcat, deploy the vnu.war file. You can do this via the Tomcat Manager application or by copying the file into the webapps directory.

Once deployed, the application is typically accessible at http://localhost/[context-root]/, where the context root is usually the filename (e.g., http://localhost/vnu/).

To customize servlet filter configuration (such as disabling the inbound-size-limit-filter), you can modify the /WEB-INF/web.xml file inside the WAR archive using a ZIP-handling program.