diff --git a/README.md b/README.md index 8374d36..10115c1 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,9 @@ A privacy-respecting alternative front-end for Pixiv that doesn't suck. ![CI badge](https://ci.codeberg.org/api/badges/12556/status.svg) [![Go Report Card](https://goreportcard.com/badge/codeberg.org/vnpower/pixivfe)](https://goreportcard.com/report/codeberg.org/vnpower/pixivfe) -Questions? Feedback? You can [PM me](https://matrix.to/#/@vnpower:eientei.org) on Matrix! You can also look in [Known Quirks Of PixivFE](doc/Quirks.md) to see if your issue already has a known solution. +Questions? Feedback? You can [PM me](https://matrix.to/#/@vnpower:eientei.org) on Matrix! You can also see the [Known quirks](doc/Quirks.md) page to check if your issue has a known solution. -You can keep track of this project's development [here](doc/dev/Things-to-do.md). +You can keep track of this project's development using the [roadmap](doc/dev/general.md). ## Features @@ -27,7 +27,7 @@ You can keep track of this project's development [here](doc/dev/Things-to-do.md) 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. -[How to host PixivFE using Docker, or Caddy](doc/Hosting.md) +To deploy PixivFE using Docker or the compiled binary, see the [Hosting PixivFE](doc/Hosting.md) wiki page. A guide on [hosting a Pixiv image proxy](doc/Hosting-an-image-proxy-server-for-Pixiv.md) is also available if you don't want to use a public one. ## Development @@ -52,18 +52,16 @@ PIXIVFE_DEV=1 go run . ## Instances -| Name | URL | Country | Cloudflare? | [Mozilla Observatory](https://observatory.mozilla.org/faq/) grade | Uptime | -| ------------------ | ---------------------------- | ------- | ----------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| exozyme (Official) | https://pixivfe.exozy.me | US | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.exozy.me) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383741-c72f1ae6562dc943d032ba96) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383741-c72f1ae6562dc943d032ba96?label=uptime%20%2Fmonth) | -| dragongoose | https://pixivfe.drgns.space | US | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.drgns.space) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383743-c0cf0d6b5dbb09c8dbe7dc53) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383743-c0cf0d6b5dbb09c8dbe7dc53?label=uptime%20%2Fmonth) | -| ducks.party | https://pixivfe.ducks.party | NL | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.ducks.party) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383747-c92c281f520d52fe3fd894ed) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383747-c92c281f520d52fe3fd894ed?label=uptime%20%2Fmonth) | -| perennialte.ch | https://pixiv.perennialte.ch | AU | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixiv.perennialte.ch) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383748-503799f65873a23dbc860a02) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383748-503799f65873a23dbc860a02?label=uptime%20%2Fmonth) | +| Name | URL | Country | Cloudflare usage | [Mozilla Observatory](https://observatory.mozilla.org/faq/) grade | Uptime | +| ------------------ | ---------------------------- | ------- | ---------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| exozyme (Official) | https://pixivfe.exozy.me | US | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.exozy.me) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383741-c72f1ae6562dc943d032ba96) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383741-c72f1ae6562dc943d032ba96?label=uptime%20%2Fmonth) | +| dragongoose | https://pixivfe.drgns.space | US | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.drgns.space) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383743-c0cf0d6b5dbb09c8dbe7dc53) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383743-c0cf0d6b5dbb09c8dbe7dc53?label=uptime%20%2Fmonth) | +| ducks.party | https://pixivfe.ducks.party | NL | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixivfe.ducks.party) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383747-c92c281f520d52fe3fd894ed) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383747-c92c281f520d52fe3fd894ed?label=uptime%20%2Fmonth) | +| perennialte.ch | https://pixiv.perennialte.ch | AU | No | ![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/pixiv.perennialte.ch) | ![Uptime Robot status](https://img.shields.io/uptimerobot/status/m796383748-503799f65873a23dbc860a02) ![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m796383748-503799f65873a23dbc860a02?label=uptime%20%2Fmonth) | -For information on instance uptime, see the [PixivFE instance status page](https://stats.uptimerobot.com/FbEGewWlbX). +For more information on instance uptime, see the [PixivFE instance status page](https://stats.uptimerobot.com/FbEGewWlbX). -[How to host a Pixiv image proxy](doc/Hosting-an-image-proxy-server-for-Pixiv.md) - -Hosted one yourself? Create a pull request to add it here! +If you are hosting your own instance, you can create a pull request to add it here! ## License & Attributions diff --git a/doc/Quirks.md b/doc/Quirks.md index 715fc4b..b4c6d83 100644 --- a/doc/Quirks.md +++ b/doc/Quirks.md @@ -1,9 +1,7 @@ -# Known Quicks Of PixivFE +# Known quirks -## Why don't my userstyles work? +## Why aren't my userstyles working? Origin: https://codeberg.org/VnPower/PixivFE/pulls/62#issuecomment-1568191 -This website uses CSP, which blocks the loading of inline styles. In the case of Stylus, you need to enable **Advanced > Circumvent CSP 'style-­src' via adoptedSty­leSheets** in Stylus Options. - -Reference: https://github.com/openstyles/stylus/issues/1685 +PixivFE implements a strong [Content-Security-Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy) that prevents inline styles from being loaded. If you're using Stylus, you need to enable **Advanced > Circumvent CSP 'style-­src' via adoptedSty­leSheets** in Stylus Options (see [issue #1685](https://github.com/openstyles/stylus/issues/1685) on the Stylus GitHub repository).