Updated: 2026-11-09. Platforms ship independently. Check the relevant release for its version, system requirements, and installation notes.

ScrapeFun brings metadata scraping, resource browsing, playback, reading, and user management into a self-hosted service. Deploy Server on Linux / NAS, macOS, or Windows, then connect through a browser or a dedicated Client.

This repository contains public product documentation, deployment templates, and extension examples. It does not publish the complete product source code. Platform repositories provide release assets and installation instructions.

Downloads and deployment

Deploy a Server first, then install a Client if needed. Server stores libraries, users, configuration, and progress. Client connects to an existing Server. You can also access Server directly in a browser.

Type	Platform	Published installation format	Links
Server	Linux / NAS	Docker, supports only linux/amd64	Docker deployment
Server	Linux	Native systemd / amd64 0.6.0	Installation · v0.6.0
Server	Android	arm64-v8a APK 0.5.10	Installation · Stable release
Server	macOS	Apple Silicon / arm64 DMG 0.5.4	0.5.4 manual download
Server	Windows	x64 EXE / Microsoft Store MSIX	GitHub release · Microsoft Store
Client	Linux	x64 DEB / AppImage 0.6.0	Installation · v0.6.0
Client	macOS	Apple Silicon / arm64 DMG 0.5.4	0.5.4 manual download
Client	Windows	x64 EXE / Microsoft Store APPX	GitHub release · Microsoft Store
Client	Android	arm64-v8a / armeabi-v7a APK 0.6.0	Installation · Stable release

Available architectures and formats follow the actual Release Assets and Docker tag manifests.

Server 0.6.0 is available for Docker, native Linux, and Windows EXE. Client 0.6.0 is available for Linux, Windows EXE, and Android. This release adds custom metadata and per-library detail layouts and improves detail loading. Windows GitHub installers are unsigned and may trigger Microsoft Defender SmartScreen. Check the Microsoft Store listings for their available versions.

Quick start

On an x86-64 Linux host, install Docker, the Docker Compose plugin, and flock (usually provided by util-linux), then run:

curl -fsSL https://raw.githubusercontent.com/HaoweiLi97/ScrapeFun/main/scripts/one-click-compose-deploy.sh | bash -s -- stable

The installer automatically detects GPU access and validates it inside the container; set SCRAPEFUN_GPU_MODE to choose a mode explicitly. By default, the script stores deployment configuration in ~/scrapefun, persistent data in ~/scrapefun-data, and starts app plus a separate updater.

Open the following address after deployment:

http://SERVER_IP:8096

Complete the setup wizard, configure administrator credentials, and add storage and libraries. NAS management-panel users should follow the Compose guide. Back up your data before upgrading an existing instance.

Capabilities

Area	Capabilities
Media organization	Movie and TV metadata scraping, artwork and cast information, cleaning rules, custom and combined scrapers
Comic reading	Comic scanning, browser and client reading, saved reading progress
Remote resources	WebDAV / AList browsing and file management, remote-library scanning, resource connections
Playback and subtitles	Browser and client playback, synchronized playback progress, subtitle search and import
User management	Administrator and standard users, library access permissions, multiple devices
Extensions	Emby / Jellyfin-style compatibility interfaces, picture enhancement, and other Pro features

Some advanced features require a valid ScrapeFun Pro entitlement. Feature scope and duration follow the product entitlement information, purchase information, and the instance's license page. Player compatibility also depends on the client version, media codec, and Server configuration.

Interface previews

These screenshots were captured from the running ScrapeFun application on November 3, 2026. They show the Chinese interface; appearance can vary with platform, version, and personal settings.

Comic library and reading progress

View comic covers, volumes, and reading progress, then continue where you left off.

Book library

Browse books by cover and view titles in progress.

Remote resource browsing

Browse remote directories and switch between posters and file lists.

Title details

View artwork, metadata, descriptions, reading progress, and volume controls together.

Documentation

Task	Guide
API integration and automation	Authentication, media, and tasks · OpenAPI
Settings and AI connections	Common settings · Text, voice, and image AI
Author and manage scrapers	Methods and data formats · Testing and management API
Linux installation, updates, and channel changes	Docker deployment and operations
Manual NAS configuration	Docker Compose deployment
Backup, migration, and recovery	Persistent data, backup, and recovery
Configuration fields	Environment example · Configuration schema
Custom scrapers	English developer guide · Chinese guide
Versions and update behavior	Releases and compatibility
Product issues and vulnerabilities	Support · Security
Software licensing	Licensing and agreements

More usage information is available in the online documentation.

Data and updates

Persist the complete Docker data root:

volumes:
  - ./scrapefun-data:/app/data

Updating restarts Server and interrupts playback and background tasks. Back up first, update, then check login, libraries, images, and playback and reading progress. latest follows stable releases and beta follows prereleases; use an explicit version tag when you need a fixed version.

macOS Server 0.5.4 requires Apple Silicon and macOS 27.0 or later; macOS Client 0.5.4 requires Apple Silicon and macOS 26.0 or later. Both use ad-hoc integrity signatures without Developer ID signing or Apple notarization. Install this version manually and follow its Release instructions to remove quarantine if needed.

Contact and licensing

Report public product issues through GitHub Issues or the product feedback page. For accounts, payments, or private logs, contact [email protected]. Commercial inquiries: [email protected].

See licensing and agreements for the scope of software, documentation, and third-party component licenses.