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.
- 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
- Backend: Kotlin + Ktor (
/api+ SSE) - Frontend:
web-uistatic assets - Storage: SQLite + file storage under
data/
Default data layout:
data/settings.jsondata/rikka_hub.dbdata/upload/
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 -dRun with arm64 tag:
RIKKAHUB_IMAGE_TAG=webdist-arm64 docker compose up -dOpen: http://127.0.0.1:8080/
If you want to build from local source, uncomment the build block in docker-compose.yml, then run:
docker compose up -d --buildRequirements:
- JDK 17+
- Node.js 20+
Linux/macOS:
./restart-fullstack.shWindows PowerShell:
./restart-fullstack.ps1Values currently set in docker-compose.yml:
HOST=0.0.0.0PORT=8080DATA_DIR=/dataWEB_UI_DIR=/app/web-uiASSETS_DIR=/app/assetsJWT_ENABLED=false
Compose image selector:
RIKKAHUB_IMAGE_TAGdefaultwebdist- set
RIKKAHUB_IMAGE_TAG=webdist-arm64for arm64 image
Notes:
ACCESS_PASSWORDis not set in currentdocker-compose.yml.- Persistent data is mounted by
./data:/data.
Push to webdist triggers .github/workflows/docker-image.yml.
Published image tags on GHCR:
ghcr.io/<owner>/<repo>:webdistghcr.io/<owner>/<repo>:<commit_sha>ghcr.io/<owner>/<repo>:webdist-arm64ghcr.io/<owner>/<repo>:<commit_sha>-arm64
dist/is ignored by Git and is no longer generated byrestart-fullstackscripts.data/, local toolchains, and personal local files are ignored.
See LICENSE.