What Is PixivFE?

Updated

PixivFE (short for "Pixiv FrontEnd") is an open-source, self-hostable alternative front-end for pixiv. If you want to browse pixiv through a different interface, or you want to run that interface yourself instead of relying on someone else's server, PixivFE is built for exactly that. The documentation site at pixivfe-docs.pages.dev is the official reference covering how to use it, how to host it, and how to develop on it.

Who it's for

PixivFE serves two broad audiences, and the documentation is organized around them:

  • Users who want to access pixiv through the PixivFE interface rather than pixiv's own front-end.
  • Self-hosters who want to run their own PixivFE instance, and optionally their own supporting infrastructure.
  • Developers who want to contribute to or extend the project.

What the documentation covers

The docs are split into a few main areas, each answering a different question:

Section What it helps you do
Home Get oriented — what PixivFE is and where to start
Instance list Find existing PixivFE instances to use
Public image proxies Understand the proxy servers that serve images
Known quirks Learn about expected oddities before you're surprised by them
Hosting Run your own PixivFE instance and configure it
Authentication for the pixiv API Handle the credentials needed to talk to pixiv
Development Roadmap, scope, feature tracker, guidelines, testing, and coding tips

The presence of a dedicated Hosting section, including "Hosting an image proxy server," signals that self-hosting is a first-class use case, not an afterthought. You can run just the front-end, or go further and operate the image proxy that supports it.

Key things to know before you start

  • It's an alternative front-end, not a replacement for pixiv. PixivFE sits in front of pixiv; it doesn't host the artwork itself.
  • Authentication matters. Because it talks to the pixiv API, there's a dedicated authentication topic in the docs. Check it before assuming you can just point PixivFE at pixiv and go.
  • Expect quirks. The docs maintain a "Known quirks" page, which is worth reading so you can tell a real problem from a documented behavior.
  • Self-hosting has moving parts. Beyond the app itself, you may need an image proxy server. The docs treat this as its own hosting task.

How to decide if it's for you

  • If you just want to use PixivFE, start with the Instance list to find a running instance, then skim Known quirks.
  • If you want to host your own, go to the Hosting section and read the configuration options and the image proxy guidance.
  • If you want to contribute, the Development section — roadmap, scope, feature tracker, guidelines, testing, and coding tips — is where to begin.

The documentation site is the authoritative source for current details, so treat the sections above as your map and the individual pages as the specifics.