Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ronny1982 committed Oct 7, 2023
1 parent 99a43c2 commit ea1cd81
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# HakuNeko Assistant

Browser extensions to interact with your running [HakuNeko](https://git.io/hakuneko) instance.
Browser extensions to interact with your running [HakuNeko](https://github.com/manga-download/haruneko) instance.
- Bypass CloudFlare
- Open Media-Containers
- Open Media-Containers

## Installation

...

### Chrome/Edge

- Download the latest extension from [GitHub](https://github.com/manga-download/haruneko-assistant/releases)
- Extract the content of the Extension (Zip Archive)
- Open Chrome/Edge and switch to the Extension Manager
- Enable Developer Mode and Load the unpacked Extension from its Directory

## Build/Bundle Chrome Extension

- Run `npm run build --workspaces`
- Install a version of chromium with e.g., `npx playwright-chromium install` and use the [Command Line](https://developer.chrome.com/docs/extensions/mv3/linux_hosting/#package-through-command-line)
- Pack the Extension directly from the Browser's Extension Manager
28 changes: 28 additions & 0 deletions docs/Connect with HakuNeko.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Connect with HakuNeko

1. Start HakuNeko and open the Settings
- Enable the option for Remote Control from 3rd Party Applications
- You may change the `Port` on which HakuNeko is listening to 3rd Party Applications
- You must change the default `Secret` to prevent connections from unauthorized Users

![](./hakuneko-rpc.png)

2. Install the HakuNeko Assistant Browser Extension for Chrome/Edge
- Download the latest extension from [GitHub](https://github.com/manga-download/haruneko-assistant/releases)
- Extract the content of the Extension (Zip Archive)
- Open Chrome/Edge and switch to the Extension Manager
- Enable Developer Mode and Load the unpacked Extension from its Directory

3. Open the Extension in your Browser
- Make sure the `Connection` uses the same `Port` as configured in HakuNeko
- Make sure the `Secret` is the same as configured in HakuNeko

![](./hakuneko-assistant.png)

4. Bypass CloudFlare protected Website
- Make sure HakuNeko is running and Remote Control is enabled
- In your Chrome/Edge Browser navigate to a manga website protected by CloudFlare
- Wait until the CloudFlare protection/captcha is bypassed
- Open the HakuNeko Assistant Extension
- Click the `Bypass CloudFlare` button
- This website can now be accessed by HakuNeko (until the CloudFlare session expires)
Binary file added docs/hakuneko-assistant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/hakuneko-rpc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ea1cd81

Please sign in to comment.