goyimnose/api-HydrusNetwork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

change installation process

Browse Source
This commit is contained in:
Nose
2026-04-18 18:33:10 -07:00
parent 3bd335cfb5
commit e9c72d13df
4 changed files with 167 additions and 133 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -6
View File
@@ -4,8 +4,8 @@ API Media Player is a web-first PWA for browsing Hydrus media and handing playba
## What works today
- Browse the seeded demo library right after `npm install` and `npm run dev`
- Connect to a real Hydrus client from the Settings page or a local `.env` file
- Start the app with `npm start` and connect a Hydrus server from the web settings screen
- Add one or more Hydrus clients from the Settings page or a local `.env` file
- Launch playback in native apps:
- Windows and Linux desktop: `mpv` through `mpv-handler://`
- Android: `mpv-android` through `intent://`
@@ -23,12 +23,12 @@ npm install
3. Start the dev server:
```bash
npm run dev
npm start
```
4. Open `http://localhost:5173`.
The app includes sample data, so you can verify the UI immediately. Playback itself is always external, so browsing works before player setup, but actual media launch depends on the platform-specific player flow below.
On a fresh install the app opens the Hydrus server settings first. Add your host, port, and API key there, test the connection, then save the server before browsing the library. Playback itself is always external, so actual media launch still depends on the platform-specific player flow below.
## Connect Hydrus (optional)
@@ -41,7 +41,7 @@ VITE_HYDRUS_API_KEY=
VITE_HYDRUS_SSL=false
```
You can also add or edit servers from Settings inside the app. The first run seeds a sample server entry so you only need to supply your `Hydrus-Client-API-Access-Key` and test the connection.
You can also add or edit servers entirely from Settings inside the app. Nothing is preconfigured on first launch, so you enter the Hydrus connection details yourself.
Browsers cannot attach custom Hydrus API headers to direct media URLs. If your Hydrus setup requires header-based authentication for file access, put a trusted reverse proxy in front of it or provide playable URLs another way.
@@ -119,7 +119,7 @@ It only activates on `localhost`, loopback, RFC1918 LAN IPs, and `.local` or `.l
## Useful commands
```bash
npm run dev
npm start
npm run build
npm run preview
npm run typecheck