Skip to content

rVnPower/PixivFE

Repository files navigation

PixivFE

A open source alternative frontend for Pixiv.

Notice: PixivFE now has a public room on Matrix, join here!

Get it on Codeberg

CI badge Go Report Card Crowdin

Docker Pulls Docker Stars

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

Use our build tool: ./build.sh help.

Here are the build prerequisites. You may only install some of them.

Name What for Recommended way to install
Go To build PixivFE from source Use system package manager (go)
Sass To build CSS stylesheets from SCSS. Will be run by PixivFE in development mode Use system package manager (dart-sass), or see below
jq To extract i18n strings Use system package manager (jq)
semgrep To extract i18n strings and scan the source code for errors See official instructions
Crowdin CLI To upload and download i18n strings. Only core developers need this See our documentation

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

Then, run the project:

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

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

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 build.sh shell script 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

Warning: Instances listed below were deemed to have complied with the instance rules. Any public instance that isn't in this list should be used at your own risk.

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

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.


Disclaimer: This application was NOT developed, created, or distributed by pixiv.