pixivfe-docs.pages.dev

The PixivFE documentation homepage links directly to both the Instance list and Public image proxies pages. Use these if you want to browse pixiv through PixivFE without hosting anything yourself. If you plan to run your own deployment, you'll instead want the Hosting section on the same page.

What PixivFE is

PixivFE (short for Pixiv FrontEnd) is described in its documentation as an open-source, self-hostable alternative front-end for pixiv. That means it's a separate interface for browsing pixiv content, and anyone can run their own copy of it.

Finding an instance or proxy

The documentation homepage is organized as a set of entry points. The two relevant to non-self-hosters are:

Both are listed on the homepage alongside other sections such as Known quirks, Hosting, Authentication for the pixiv API, and Development.

Steps

1. Open the PixivFE documentation site.
2. On the homepage, locate the Instance list link.
3. Pick an instance from that list and open it to start browsing.
4. If images don't load on the instance you chose, check the Public image proxies page for a proxy you can use.

Expected result

You end up on a working PixivFE front-end without installing or configuring anything, and you have a proxy option if image loading fails.

Common snags

• Images not loading. This is the main reason the public image proxy list exists — an instance may need a proxy configured for images to display.
• Instance availability. The list is a directory of public deployments; individual instances are run by different people and may behave differently. The documentation also keeps a Known quirks page, which is worth checking when something looks off.
• Self-hosting instead. If you'd rather run your own, start from the Hosting section, which covers configuration options, hosting PixivFE, hosting an image proxy server, and authentication for the pixiv API.

Other sections worth knowing

The same homepage also points to Development material (roadmap, scope, feature tracker, guidelines, testing tools, coding tips, design flaws, helpful resources, internationalization), Features (caching, tracing, flamegraph), and an Archive covering framework migration and old i18n. These are aimed at contributors and maintainers rather than everyday users.

PixivFE's documentation lists a "Known quirks" page, which means the project openly tracks behaviors that differ from what you might expect from pixiv's official front-end. The documentation does not reproduce the contents of that page in the material available here, so the specific quirks themselves are not enumerated. What can be said with confidence is that PixivFE is an open-source, self-hostable alternative front-end for pixiv, and that its maintainers treat "known quirks" as a distinct documentation topic alongside hosting, configuration, authentication, and development.

Why a "Known quirks" page exists

An alternative front-end sits between you and pixiv's own services. That position creates predictable categories of difference:

• Rendering and layout. PixivFE is its own front-end, not a skin over pixiv, so pages are built by the project rather than by pixiv.
• Data access. It talks to the pixiv API, and the docs include a separate "Authentication for the pixiv API" topic — a sign that access to pixiv data involves its own setup rather than being fully transparent.
• Images. The docs list "Public image proxies" and "Hosting an image proxy server" as separate topics, so image delivery can route through a proxy rather than directly from pixiv.
• Caching. "Caching" appears as a feature topic, so what you see may be served from a cache rather than fetched live.

Each of these is a plausible source of behavior that differs from pixiv's official front-end, and the quirks page is where the project records the concrete cases.

What to check before assuming something is broken

If you encounter behavior that seems wrong, the documentation structure suggests an order of checks:

1. Read the Known quirks page first. It exists precisely to distinguish intended-but-unusual behavior from actual bugs.
2. Check whether the instance uses an image proxy. If images fail or load differently, the proxy configuration is the relevant variable, not the front-end code.
3. Consider caching. A stale or unexpected view may be a cache effect rather than a data problem.
4. Check API authentication. If content is missing or limited, the pixiv API authentication setup for that instance is a likely factor.

Limits of this answer

The available documentation excerpt names the "Known quirks" page but does not include its list. Anyone who needs the actual quirks should read that page directly on the PixivFE documentation site, and should treat the categories above as the areas where quirks are most likely to appear rather than as a substitute for the list itself.

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:

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.

PixivFE is an open-source, self-hostable alternative front-end for pixiv, and its documentation treats development as an ongoing, publicly tracked effort rather than a finished product. The docs include dedicated pages for Development, Roadmap, Scope, and a Feature tracker, alongside supporting material on Testing, Tools, Coding tips, and Design flaws. If you want to know where the project stands or how to get involved, those documentation sections are the place to start.

What the documentation says about development

The PixivFE documentation lists a Development section that groups the project's contributor-facing material. Based on the documentation structure, this section covers:

• Roadmap – the planned direction of the project.
• Scope – what the project intends to cover (and, by implication, what falls outside it).
• Feature tracker – a running record of features.
• Guidelines – expectations for contributors.
• Testing – how the project is tested.
• Tools – utilities relevant to development.
• Coding tips – practical notes for working on the codebase.
• Design flaws – acknowledged shortcomings in the current design.

The presence of a "Design flaws" page is notable: it signals that the project documents its own weaknesses openly rather than presenting only polished features. For anyone evaluating whether to contribute or self-host, that transparency is useful context.

How features and functionality are documented

Beyond the contributor pages, the documentation also covers functional areas that affect both users and developers:

• Features – an overview of what PixivFE provides.
• Caching – how caching is handled.
• Tracing flamegraph – performance tracing output.
• Internationalization – translation and locale support, with an "Old I18n" page retained under an Archive section.
• Framework migration – also archived, indicating the project has moved between frameworks at least once.

The Archive section (containing Framework migration and Old I18n) suggests these are historical records rather than current guidance. If you are reading the docs, treat archived pages as background, not as instructions for the current codebase.

Where to find the project's current state

The documentation's Home page links to several entry points that matter for tracking status:

For development status specifically, the Roadmap and Feature tracker pages are the most direct sources. The Known quirks page is worth reading alongside them, since it captures behavior that may look like bugs but is documented as expected.

Getting involved

If you want to contribute, the documentation's Development section provides the starting points: read the Guidelines first, then check Testing and Tools to understand the workflow. The Coding tips page offers practical advice, and Design flaws tells you where the project already knows it has problems — often a good place to find work that needs doing.

The docs also note dates on the Home page (February 28, 2025 and August 26, 2024), which appear to be update markers. Because the project is actively documented, check the live documentation at pixivfe-docs.pages.dev rather than relying on any single snapshot, since roadmap items and feature status can change.

PixivFE is an open-source, self-hostable alternative front-end for pixiv, and its documentation at pixivfe-docs.pages.dev covers self-hosting in three parts: hosting PixivFE itself, configuration options, and hosting an image proxy server. To host it yourself, you need a server you control, the ability to run the PixivFE application, and — if you want images to load reliably — a separate image proxy server. The documentation also notes that authentication for the pixiv API is part of the setup picture, so plan for that before you start.

What the documentation covers

The PixivFE docs are organized so that hosting is a first-class topic rather than an afterthought. The relevant sections are:

• Hosting — the main entry point for running your own instance.
• Hosting Configuration options — the settings you can adjust for your deployment.
• Hosting an image proxy server — a separate guide, because image proxying is handled by its own service.
• Authentication for the pixiv API — how your instance authenticates against pixiv.
• Public image proxies — a list of existing proxies, useful if you don't want to run your own.
• Instance list — public PixivFE instances you can compare against or use instead of self-hosting.
• Known quirks — documented behaviors to expect.

There is also a Development section (Roadmap, Scope, Feature tracker, Guidelines, Testing, Tools, Coding tips, Design flaws, Helpful resources, Internationalization) and a Features section (Caching, Tracing flamegraph), plus an Archive covering framework migration and old I18n. These matter if you intend to modify or contribute to PixivFE, not just run it.

Before you start

Confirm these prerequisites against the current docs, since the documentation is the authoritative source and details may change:

1. A host you control — a server or platform where you can run the PixivFE application. The docs' Hosting section is where the specific requirements live.
2. A decision on image proxying — either run your own image proxy server (covered by its own hosting guide) or rely on a public image proxy from the documented list.
3. A plan for pixiv API authentication — the docs include a dedicated authentication topic, so treat this as a required configuration step rather than an optional one.
4. Familiarity with the configuration options — review the configuration options page before deploying so you know what is tunable.

Hosting steps

The documentation does not present a single copy-paste command sequence in its home page; the actual instructions are inside the Hosting section. The workflow the docs imply is:

1. Read the Hosting page and follow its deployment instructions for PixivFE.
2. Apply your configuration using the documented configuration options.
3. Set up authentication for the pixiv API as described in the authentication topic.
4. Stand up an image proxy server if you want self-hosted image delivery, following the image proxy hosting guide. If you prefer not to, consult the public image proxies list.
5. Verify by loading your instance and checking that content and images resolve. Review Known quirks if something behaves unexpectedly.

Because the docs separate "Hosting PixivFE" from "Hosting an image proxy server," expect these to be two distinct deployments rather than one combined install.

Choosing between self-hosting and using an existing instance

Common sticking points

• Treating image proxying as optional setup. The docs give it its own hosting guide, which signals it is a separate service you may need to deploy.
• Skipping authentication. Pixiv API authentication has its own documentation topic, so don't assume an unauthenticated instance will work as expected.
• Ignoring Known quirks. The docs maintain a quirks page precisely because some behaviors are expected rather than bugs.
• Assuming the home page is the full guide. The home page is an index; the Hosting, Configuration options, and image proxy pages contain the actual instructions.

For exact commands, required software versions, and current configuration keys, go directly to the Hosting and Configuration options pages in the PixivFE documentation — those are the maintained sources, and this overview is only a map of what you'll find there.