Skip to content
longyq20Public
forked from rikkahub/rikkahub

About

RikkaHub is an Android APP that supports for multiple LLM providers.

Resources

Stars

15 stars

Watchers

0 watching

Forks

 
 

Latest commit

 

History

2,034 Commits

Folders and files

Repository files navigation

RikkaHub WebDist

Chinese | English

This branch ships the portable Web UI + Kotlin/Ktor backend source of RikkaHub. It is intended for direct fork/build/run on Windows, Linux, and Docker.

What This Branch Contains

  • Portable backend modules: backend-core, backend-storage-sqlite, backend-migration, backend-server
  • Web frontend source: web-ui (served by backend static hosting)
  • Docker deployment files: Dockerfile, docker-compose.yml
  • One-command local scripts: restart-fullstack.sh, restart-fullstack.ps1

Runtime Architecture

  • Backend: Kotlin + Ktor (/api + SSE)
  • Frontend: web-ui static assets
  • Storage: SQLite + file storage under data/

Default data layout:

  • data/settings.json
  • data/rikka_hub.db
  • data/upload/

Quick Start

Option A: Docker with published image (default compose)

docker-compose.yml supports these image tags:

  • amd64: ghcr.io/longyq20/rikkahub:webdist
  • arm64: ghcr.io/longyq20/rikkahub:webdist-arm64

Run with default tag (webdist):

docker compose up -d

Run with arm64 tag:

RIKKAHUB_IMAGE_TAG=webdist-arm64 docker compose up -d

Open: http://127.0.0.1:8080/

Option B: Docker build from source

If you want to build from local source, uncomment the build block in docker-compose.yml, then run:

docker compose up -d --build

Option C: Local (Windows/Linux/macOS)

Requirements:

  • JDK 17+
  • Node.js 20+

Linux/macOS:

./restart-fullstack.sh

Windows PowerShell:

./restart-fullstack.ps1

Environment Variables

Values currently set in docker-compose.yml:

  • HOST=0.0.0.0
  • PORT=8080
  • DATA_DIR=/data
  • WEB_UI_DIR=/app/web-ui
  • ASSETS_DIR=/app/assets
  • JWT_ENABLED=false

Compose image selector:

  • RIKKAHUB_IMAGE_TAG default webdist
  • set RIKKAHUB_IMAGE_TAG=webdist-arm64 for arm64 image

Notes:

  • ACCESS_PASSWORD is not set in current docker-compose.yml.
  • Persistent data is mounted by ./data:/data.

CI

Push to webdist triggers .github/workflows/docker-image.yml.

Published image tags on GHCR:

  • ghcr.io/<owner>/<repo>:webdist
  • ghcr.io/<owner>/<repo>:<commit_sha>
  • ghcr.io/<owner>/<repo>:webdist-arm64
  • ghcr.io/<owner>/<repo>:<commit_sha>-arm64

Notes

  • dist/ is ignored by Git and is no longer generated by restart-fullstack scripts.
  • data/, local toolchains, and personal local files are ignored.

License

See LICENSE.

About

RikkaHub is an Android APP that supports for multiple LLM providers.

Resources

Stars

15 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages