Skip to content

Commit ab65102

Browse files
committed
Rename project
1 parent df6dcd4 commit ab65102

File tree

5 files changed

+35
-31
lines changed

5 files changed

+35
-31
lines changed

.github/workflows/rust.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
OS: windows-latest
3232
runs-on: ${{ matrix.OS }}
3333
env:
34-
NAME: plex-anihook
34+
NAME: anifunnel
3535
TARGET: ${{ matrix.TARGET }}
3636
OS: ${{ matrix.OS }}
3737
steps:

Cargo.lock

Lines changed: 15 additions & 15 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[package]
2-
name = "plex-anihook"
2+
name = "anifunnel"
33
version = "1.0.0"
44
edition = "2021"
55
resolver = "2"

Dockerfile

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ FROM rust:1.65 as build
44

55
ENV CARGO_NET_GIT_FETCH_WITH_CLI=true
66

7-
RUN USER=root cargo new --bin plex-anihook
7+
RUN USER=root cargo new --bin anifunnel
88

99
# Build dependencies separately for layer caching.
10-
WORKDIR ./plex-anihook
10+
WORKDIR ./anifunnel
1111
COPY ./Cargo.lock ./Cargo.lock
1212
COPY ./Cargo.toml ./Cargo.toml
1313
RUN cargo build --release
1414

1515
# Clean the temporary project.
16-
RUN rm src/*.rs ./target/release/deps/plex_anihook*
16+
RUN rm src/*.rs ./target/release/deps/anifunnel*
1717

1818
ADD . ./
1919
RUN cargo build --release --verbose
@@ -28,12 +28,12 @@ RUN apt-get update && apt-get install -y \
2828
openssl \
2929
&& rm -rf /var/lib/apt/lists/*
3030

31-
COPY --from=build /plex-anihook/target/release/plex-anihook .
31+
COPY --from=build /anifunnel/target/release/anifunnel .
3232

3333
ENV ANILIST_TOKEN= \
3434
BIND_ADDRESS=0.0.0.0 \
3535
PORT=8000
3636

3737
EXPOSE 8000
3838

39-
CMD ["./plex-anihook"]
39+
CMD ["./anifunnel"]

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
1-
# plex-anihook
1+
# anifunnel
22

33
Plex webhook service to automatically update your Anilist watching list.
44

55
## Description
66

7-
plex-anihook is a web server that will consume incoming Plex webhooks and update your Anilist watching list whenever you finish watching an episode.
7+
anifunnel is a web server that will consume incoming Plex webhooks and update your Anilist watching list whenever you finish watching an episode.
88

99
The updating logic is rather conservative: the anime must be found within your watching list, and must have a matching episode count. So if you watch the first episode of a show, it will not add the show to your watching list on your own. Likewise, if you watch episode six of a show that matches a title where you have only the first two episodes marked as watched, it will also not update it, as it's looking for an anime that is at
1010

11-
plex-anihook implements fuzzy matching logic to allow the updating the work even if the titles aren't an exact match between your Plex library and Anilist. So for example "Boku no Hero Academia 6" can be matched against "Boku no Hero Academia (2022)" and "Uzaki-chan wa Asobitai! ω" can be matched against "Uzaki-chan wa Asobitai! Double".
11+
anifunnel implements fuzzy matching logic to allow the updating the work even if the titles aren't an exact match between your Plex library and Anilist. So for example "Boku no Hero Academia 6" can be matched against "Boku no Hero Academia (2022)" and "Uzaki-chan wa Asobitai! ω" can be matched against "Uzaki-chan wa Asobitai! Double".
1212

1313
## Usage
1414

1515
### Authorization
1616

17-
Before starting to use plex-anihook, you must fetch an API token.
17+
Before starting to use anifunnel, you must fetch an API token.
1818

1919
In order to fetch your token, visit the following URL in your browser: https://anilist.co/api/v2/oauth/authorize?client_id=9878&response_type=token
2020

@@ -25,28 +25,32 @@ Note that Anilist authorization tokens are valid for a year at a time.
2525
To start the web server, use the following command:
2626

2727
```bash
28-
plex-anihook <ANILIST_TOKEN>
28+
anifunnel <ANILIST_TOKEN>
2929
```
3030

31-
To get complete usage details, run `plex-anihook --help`.
31+
To get complete usage details, run `anifunnel --help`.
3232

33-
The alternative (and arguably easier) way to run plex-anihook is to use the ready-made Docker image.
33+
The alternative (and arguably easier) way to run anifunnel is to use the ready-made Docker image.
3434

3535
```bash
3636
docker run \
3737
-p 8000:8000 \
3838
-e "ANILIST_TOKEN=xxx" \
39-
ghcr.io/hamuko/plex-anihook:latest
39+
ghcr.io/hamuko/anifunnel:latest
4040
```
4141

4242
Both `linux/amd64` and `linux/arm64` Docker image variants are available.
4343

4444
### Enabling webhooks in Plex
4545

46-
In order to send events from Plex to plex-anihook, add the URL where your Plex server can reach plex-anihook in Plex's Webhook settings.
46+
In order to send events from Plex to anifunnel, add the URL where your Plex server can reach anifunnel in Plex's Webhook settings.
4747

4848
The webhook handler responds on `/`, so if you were running the server on your local Plex server on port 8001, you'd use `http://127.0.0.1:8001/` as the webhook URL.
4949

5050
For more information, see https://support.plex.tv/articles/115002267687-webhooks/
5151

5252
Note that webhooks require a Plex Pass subscription.
53+
54+
## Disclaimer
55+
56+
This project is not associated or affiliated with Plex or Anilist in any way or form.

0 commit comments

Comments
 (0)