PixivFE/README.md

PixivFE

A privacy-respecting alternative front-end for Pixiv that doesn't suck.

Questions? Feedback? You can PM me on Matrix! You can also see the Known quirks page to check if your issue has a known solution.

You can keep track of this project's development using the roadmap.

Features

• Lightweight - both the interface and the code
• Privacy-first - the server will do the work for you
• No bloat - we only serve HTML, CSS and minimal JS code
• Open source - you can trust me!

Development

Prerequisites:

• Go (to build PixivFE from source)
• Sass (will be run by PixivFE in development mode)
• Make (to use the Makefile)

To install Dart Sass, you can choose any of the following methods.

• use system package manager (usually called dart-sass)
• download executable from the official release page
• pnpm i -g sass

Then, run the project:

# Clone the PixivFE repository
git clone https://codeberg.org/VnPower/PixivFE.git && cd PixivFE

# Build the project
make build

# Run PixivFE in development mode (styles and templates reload automatically)
PIXIVFE_DEV=1 <other_environment_variables> make run

Using the Makefile

The project includes a Makefile to simplify common development tasks. Here are the available commands:

• make all: Run fmt, build, and test
• make fmt: Format Go code
• make build: Build the binary
• make test: Run tests
• make run: Build and run the binary
• make clean: Remove the built binary
• make install-pre-commit: Install test script as pre-commit hook
• make help: Show all available targets and their descriptions

You can use these commands to streamline your development workflow.

Hosting PixivFE

You can use PixivFE for personal use! Assuming that you use an operating system that can run POSIX shell scripts, install go, clone this repository, and use the Makefile to build and run the project. I recommend self-hosting your own instance for personal use, instead of relying entirely on official instances.

To deploy PixivFE using Docker or the compiled binary, see Hosting PixivFE.

Public Instances

Name	URL	Country	Cloudflare?	Observatory Grade	Status
exozyme (Official)	https://pixivfe.exozy.me	US	No
dragoongoose	https://pixivfe.drgns.space	US	No
ducks.party	https://pixivfe.ducks.party	NL	No
perennialte.ch	https://pixiv.perennialte.ch	AU	No
darkness.services	https://pixivfe.darkness.services	US	Yes
thebunny.zone	https://pixivfe.thebunny.zone	HR	No
thebunny.zone (🧅)	http://pixivfe.bunny5exbgbp4sqe2h2rfq2brgrx3dhohdweonepzwfgumfyygb35wyd.onion	HR	No

If you are hosting your own instance, you can create a pull request to add it here!

For more information on instance uptime, see the PixivFE instance status page.

This information is duplicated at https://pixivfe-docs.pages.dev/instance-list/.

Hosting Image Proxy Server

PixivFE can work with or without an external image proxy server. Here is the list of public image proxies. See hosting a Pixiv image proxy if you want to host one yourself.