README.md 5.5 KB

PixivFE

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

Get it on Codeberg

CI badge Go Report Card

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!

Hosting

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, modify the run.sh file, and profit! 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.

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.

Development

Requirements:

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

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

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

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

Instances

Name URL Country Cloudflare? Observatory Grade Status
exozyme (Official) https://pixivfe.exozy.me US No Mozilla HTTP Observatory Grade Status
dragoongoose https://pixivfe.drgns.space US No Mozilla HTTP Observatory Grade Status
ducks.party https://pixivfe.ducks.party NL No Mozilla HTTP Observatory Grade Status
perennialte.ch https://pixiv.perennialte.ch AU No Mozilla HTTP Observatory Grade Status
darkness.services https://pixivfe.darkness.services US Yes Mozilla 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.

License

License: AGPL3