JavPy

!Github Actions
!codecov
!npm



Contents

* Introduction
* Quick Start
* Configurations
* Acknowledgements

简介/Introduction

这是一个用来搜索日本 AV 相关信息的 NodeJS app，目前提供一个基于WebSocket的Web客户端页面。

这个app从多个网站爬取信息，但多数目标网站在一些特定地区都被禁止访问。为了更好的使用体验，建议将这个app运行在互联网管制较少的地区，如美国，日本等。

这个app提供以下功能：

* 每日最新影片
* 由番号找在基本信息及在线观看链接
* 由番号找磁力链接
* 由演员日文/英文名找演员信息，历史艺名及出演影片
* 由演员照片/电影截图找演员
---

This is a NodeJS app for searching Japanese AVs related information. This project temporarily only provides a WebSocket based web page as interface.

This app fetches information from various websites, but most of them are blocked in some regions. To experience a better travel, please host the service in somewhere having lesser Internet cencorships, like the USA, Japan, etc.

This app provides functions listed below,

* Newly released movies
* Search basic information and streaming links with movie code
* Search magnet links with movie code
* Search actress information, aliases and movies with Japanese / Romaji name.
* Actress facial recognition.

Quick Start

$3

* Simply go to Releases, download an executable and just run and enjoy.

$3

``bash
$ git clone https://github.com/TheodoreKrypton/javpy
$ cd javpy && npm install -g --only=prod
$ javpy --port 8081
`

$3

`bash
$ npm install -g --only=prod javpy
$ javpy --port 8081
`

$3

`bash
$ docker run -p 8081:8081 wheatcarrier/javpy:latest
`

Configurations

$3

如果你将服务部署在一个远程机器，像是云虚拟专用服务器上，你可能会担心网站被其他未经许可的人访问。JavPy会自动创建一个配置文件~/.JavPy/config.json。你可以将你的私人ip或ip段添加到文件中，并创建一个密码。未被认证的访问将被拦截并得到一个400错误响应。你也可以在页面左上角的设置按钮配置选项。

----

If you want to run the server on a remote machine like a cloud VPS, you may be worry about the website being accessed by unauthorised people. JavPy will automatically create a configuration file ~/.JavPy/config.json on its first run. You can add your personal IPs or IP ranges into the file and create a password. Unauthorised access will then be blocked and get a response of Error 400. You can also set the configuration with the settings button on the top left of tha web page.


注意：若使用docker进行服务，请务必记得在退出docker前将config文件保存，不管是通过docker cp进行备份或通过docker commit提交修改。

----

Attention: If you are serving with docker, please don't forget to save your config file before exiting the container. You can either backup the config file with docker cp or save your changes into an image with docker commit.

Using Proxy

如果你需要设置代理，请设置 PROXY 环境变量，例如：
`bash
proxy=localhost:1080 javpy # 同时设置 http 及 https 代理
`
或分别地，
`bash
http_proxy=localhost:1080 https_proxy=localhost:1081 javpy
`

----

If you need to use a proxy, please set the PROXY environment variable. For example,
`bash
proxy=localhost:1080 javpy # for both http and https proxies
`
or separately,
`bash
http_proxy=localhost:1080 https_proxy=localhost:1081 javpy
``

------------------