rayriffy-h - GitLite

KO | EN

gitlite — search

#javascript #python #react #ai #llm #deep-learning #java #windows #awesome #cli #vue #pytorch #mcp #ios

rayriffy-h

(★ 127)

Self-hosted, decentralized manga reader (Now powered by Bun)

File Explorer

Download Latest Version (.zip)

- config.json
- README.md
- - client.yml
  - release.yml
- pre-commit
- - daisyui
  - frontend-design
  - suggest-lucide-icons
  - web-design-guidelines
- extensions.json
- settings.json
- - CHANGELOG.md
  - package.json
  - README.md
  - tsconfig.json
  - tsdown.config.ts
- - CHANGELOG.md
  - package.json
  - README.md
  - tsconfig.json
  - tsdown.config.ts
- - CHANGELOG.md
  - package.json
  - README.md
  - tsconfig.json
  - tsdown.config.ts
- - CHANGELOG.md
  - package.json
  - README.md
  - tsconfig.json
  - tsdown.config.ts
- - 404.html
  - favicon.svg
  - icons.svg
  - robots.txt
- - main.tsx
  - router.ts
  - tailwind.css
- CHANGELOG.md
- index.html
- package.json
- tsconfig.app.json
- tsconfig.json
- tsconfig.node.json
- vite.config.ts
- - nhentai.ts
- .env.example
- .gitignore
- CHANGELOG.md
- docker-compose.yml
- Dockerfile
- package.json
- riffyh.config.ts
- tsconfig.json
- - CHANGELOG.md
  - package.json
  - tsconfig.json
  - tsdown.config.ts
- - CHANGELOG.md
  - package.json
  - tsconfig.json
  - tsdown.config.ts
- - CHANGELOG.md
  - package.json
  - tsconfig.json
  - tsdown.config.ts
- - bytebin.ts
  - image.ts
  - index.ts
- - image.test.ts
- CHANGELOG.md
- package.json
- tsconfig.json
- tsdown.config.ts
.gitignore
.oxfmtrc.json
.oxlintrc.json
bun.lock
Dockerfile
LICENSE
package.json
README.md
tsconfig.json
turbo.json

# Installation Guide

1. Get the code

git clone https://github.com/rayriffy/rayriffy-h

Downloads the entire project code from GitHub to your computer.

cd rayriffy-h

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t rayriffy-h .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 rayriffy-h

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

cd adapter/ehentai

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Riffy H v7

A decentralized, self-hosted, modularized manga gallery viewer.

This project is a complete overhaul of Riffy H v6. Unlike v6, which was deeply integrated with a single source and made creating new data sources difficult, v7 is designed from the ground up to be modular. We have separated the web client entirely from the API server, enabling you to host the API server yourself and easily integrate multiple distinct data sources.

## Setting Up Your Own Server

1. Initialize a new project and install the `@riffyh/commons` package.

```bash
bun init
bun add @riffyh/commons
```

2. Create a server configuration file named `riffyh.config.ts`. Configure your server and the data sources you wish to add. You can refer to the [example](./example) for a complete server configuration.

3. Install the `@riffyh/server` package and start the server.

```bash
bun add @riffyh/server
bun run server
```

## Adding Your Server to the Web Client

1. Navigate to the [settings page](https://h.riffy.in.th/settings).

2. Add your server to the list of servers. You can also provide extra headers for your requests if your server requires authentication.

## Configuration

The following options are available to be configured in your `riffyh.config.ts` file:

### `hostname`

- **Type:** `string`
- **Default:** `'0.0.0.0'`

Specifies the hostname of your server. The default is `'0.0.0.0'`, which makes the server accessible from any device on your network.

### `port`

- **Type:** `number`
- **Default:** `3000`

Specifies the port your server will run on.

### `secretboxKey`

- **Type:** `string`
- **Required:** Yes

A secretbox key used to encrypt data sent to external services. This key must be kept secret, unique, and never shared.

You can generate a new secretbox key by running:

```bash
bunx @riffyh/execute generate secretBox
```

### `dataSources`

- **Type:** `Array<`[`DataSource`](./commons/src/models/dataSourceModel.ts)`>`
- **Required:** Yes

A list of data sources to be used by your server. Please refer to the [Data Sources](#data-sources) section for more information.

### `store`

- **Type:** `Array<`[`Store`](./commons/src/models/storeModel.ts)`>`
- **Default:** `undefined`

A list of stores for each data source to be saved locally in the database via the `@riffyh/adapter-store` package.

## Data Sources

We currently provide the following officially supported data source adapters:

- [`@riffyh/adapter-nhentai`](./adapter/nhentai/)
- [`@riffyh/adapter-niyaniya`](./adapter/niyaniya/)
- [`@riffyh/adapter-ehentai`](./adapter/ehentai/)
- [`@riffyh/adapter-store`](./adapter/store/)

Beyond these, you can easily create your own data source by writing a custom adapter that satisfies the [`DataSource`](./packages/commons/src/models/dataSourceModel.ts) interface. This allows you to integrate essentially any data source into your server.

### Gallery loading protocol

`getGallery({ id })` supports two response shapes:

- Return a complete `Gallery` with `pages` when the upstream source already provides everything in one request.
- Return `GalleryMetadata` with `pageCount` for a progressive source, and also implement `getGalleryPages({ id, offset, limit })`. Page results contain ordered `pages` and a nullable `nextOffset`.

The server keeps `GET /gallery` as the complete-gallery compatibility endpoint. The web reader uses `GET /gallery/initial` followed by `GET /gallery/pages` only when the adapter returns metadata. `getFullGallery` from `@riffyh/commons` is available to command-line or storage consumers that always need a complete gallery.

We welcome contributions to this project! If you create a custom data source adapter, feel free to submit a pull request to have your package listed as a community-supported data source.