unkemptarc99/index

The /r/animepiracy index.

piracy.moe index

The frontend, editor panel, and API of the /r/animepiracy index.

Please report incorrect or missing data at our Discord server in #index-wiki, not here.

Getting started

The easiest way is to get started is by using Docker with the following command:

docker run -d -p <host-port>:8080 -v /path/on/host:/config --name=index ranimepiracy/index

You will need to change <host-port> to your desired hostname:port. The web server is not secured via SSL/TLS, it is your responsibility to put a reverse proxy in front of this container. After starting the container you can add your own Discord ID to the file /config/whitelist.json to be able to authenticate with Discord and access the editor panel.

Updating container image

To get the newest version of the container image from Docker Hub, you will need to run:

docker pull ranimepiracy/index

Afterwards, you will need to stop and remove your current running instance and start it again.

Parameters

Here is a table of the possible environment variables with their default values:

Parameter	Function
-e AUDIT_WEBHOOK=""	Webhook URL for audit log
-e DISCORD_CLIENT_ID=00000000000	Discord client ID
-e DISCORD_CLIENT_SECRET="your_discord_client_secret"	Discord client secret
-e DISCORD_REDIRECT_URI="https://piracy.moe/user/callback/"	OAuth 2.0 callback for Discord
-e DISCORD_BOT_TOKEN="your_discord_bot_token"	Required to access bot resources
-e OAUTHLIB_INSECURE_TRANSPORT="0"	Allows non-HTTPS OAuth for debugging

Building from source

To build the Docker image you will need to run:

docker build . -t index-web

Afterwards you will just need to run:

docker run -d -p <host-port>:8080 index-web

You can now open http://localhost:8080 in your browser.

Contribution

Pull requests are always welcome, but may not be always merged as the contribution needs to align with our idea for the index. If you have an idea for a feature you would like to see added, you can always open a feature request on our issue tracker or report it on our Discord server in #index-wiki.

What we use

to build this website:

• Bootstrap 5
• Tabulator
• Flask
• Flask-Discord
• Flask-Caching
• gunicorn