jhipster/jhipster-online

JHipster Online

https://github.com/jhipster/jhipster-online/actions

镜像概述和主要用途

JHipster Online是一个Web应用，允许无需在本地安装JHipster即可生成JHipster应用。这是一个开源项目（https://github.com/jhipster/jhipster-online/blob/main/LICENSE.txt%EF%BC%89%EF%BC%8C%E4%B8%BAhttps://start.jhipster.tech/%E7%BD%91%E7%AB%99%E6%8F%90%E4%BE%9B%E6%94%AF%E6%8C%81%E3%80%82

您可以免费使用[***] fork 项目，在公司内部部署私有版本。

核心功能和特性

• 无需本地安装：无需在本地安装JHipster即可生成应用
• Web界面操作：通过网页界面配置和生成JHipster项目
• 多平台支持：兼容GitHub和GitLab（包括公共实例和企业私有实例）
• 可定制化部署：支持自行部署私有实例，满足企业内部需求
• 安全认证：使用JWT进行安全认证，保障应用安全

使用场景和适用范围

• 快速生成JHipster应用，无需配置本地开发环境
• 企业内部部署私有实例，统一管理JHipster应用生成流程
• 开发团队协作，通过网页界面共享和配置项目参数
• 教学或演示场景，快速展示JHipster应用生成过程

详细使用方法和配置说明

快速启动指南

JHipster Online本身是一个JHipster应用，可参考JHipster文档了解配置和设置方法。本指南使用默认配置，具体配置细节见下一节。

前端安装和运行：

bash
yarn install && yarn start

运行数据库：

bash
docker-compose -f src/main/docker/mysql.yml up -d

运行后端：

bash
./mvnw

特定配置

本节介绍JHipster Online相比普通JHipster应用的特定配置。标准JHipster配置可参考JHipster通用应用属性。

JHipster安装和执行

JHipster Online通过运行jhipster命令行生成应用，需确保本地已安装JHipster。推荐使用官方JHipster安装文档中的"Yarn安装"方式。

可通过Spring Boot的application-*.yml文件自定义以下参数：

• jhipster命令路径
• 命令超时时间（默认120秒，生产环境通常5-6秒）
• 应用生成的临时文件夹（默认/tmp）

示例配置：

yaml
application:
    jhipster-cmd:
        cmd: /usr/local/bin/jhipster
        timeout: 60
    tmp-folder: /tmp

数据库配置

JHipster Online使用MySQL数据库，通过Spring Boot的application-*.yml文件中的标准spring.datasource配置项进行配置。

安全配置

JHipster Online使用JWT保障应用安全。生产环境下必须：

• 配置jhipster.security.authentication.jwt.key，并安全存储（不要提交到Git仓库）。推荐通过服务器环境变量或生产服务器上的特定application.yml文件配置。
• 仅通过HTTPS访问应用。可通过Spring Boot配置（见application-prod.yml注释）或使用Apache 2 HTTP服务器配合Let's Encrypt实现（官方JHipster Online网站采用此方式）。

邮件配置

邮件用于验证用户***或发送"忘记密码"邮件，默认禁用，生产环境建议配置。

需配置jhipster.mail（参考JHipster通用应用属性）和Spring Boot标准spring.mail配置项。

开发环境（dev profile）下，需启动开发邮件服务器：

bash
docker-compose -f src/main/docker/mailserver.yml up -d

可通过MailHog UI（http://localhost:8025）查看发送的邮件。

GitHub配置

通过application-*.yml中的application.github配置项设置GitHub。支持公共GitHub（https://github.com%EF%BC%89%E5%92%8C%E4%BC%81%E4%B8%9A%E7%A7%81%E6%9C%89GitHub%E5%AE%9E%E4%BE%8B%E3%80%82

需将JHipster Online配置为"OAuth App"：创建jhipster组织，进入"Settings > Developer Settings > OAuth Apps"创建新应用，回调地址为https://your-jhipster-online-url/api/github/callback。还需配置"JHipster Bot"用户（如官方使用的https://github.com/jhipster-bot%EF%BC%89%E3%80%82

配置示例（开发环境application-dev.yml，生产环境application-prod.yml）：

yaml
application:
    github:
        host: https://github.com # 连接的GitHub实例（默认公共GitHub）
        client-id: XXX # GitHub应用的OAuth Client ID
        client-secret: XXX # GitHub应用的OAuth Client Secret

GitLab配置

通过application-*.yml中的application.gitlab配置项设置GitLab。支持公共GitLab（[***]

需创建"JHipster Bot"用户，登录后通过"Settings > Applications > Add new application"创建应用：

• 名称：jhipster
• 重定向URI：https://your-jhipster-online-url/api/gitlab/callback
• 权限范围：api和read_user

保存后获取Application Id和Secret，用于配置。

配置示例（开发环境application-dev.yml，生产环境application-prod.yml）：

yaml
application:
    gitlab:
        host: https://gitlab.com # 连接的GitLab实例（默认公共GitLab）
        client-id: XXX # GitLab应用ID
        client-secret: XXX # GitLab应用密钥
        redirect-uri: XXX # 认证后重定向URI，需在GitLab应用回调URL中注册

生产构建

生成生产构建包（与普通JHipster应用相同）：

bash
./mvnw -Pprod clean package

使用Docker

可将应用及依赖服务完全容器化。首先构建应用镜像：

bash
docker build -t jhonline .

然后运行：

bash
docker compose -f src/main/docker/app.yml up -d

部署到Google App Engine (GAE) 灵活环境

• 通过https://github.com/jhipster/jhipster-online/releases%E5%8F%AF%E9%83%A8%E7%BD%B2%E5%88%B0GAE%E7%81%B5%E6%B4%BB%E7%8E%AF%E5%A2%83%E3%80%82
• 创建新发布会触发https://github.com/jhipster/jhipster-online/blob/main/.github/workflows/deploy.yml%E3%80%82
• 该工作流包含Docker构建并将镜像推送到Google容器注册表，使用Cloud Monitoring和Cloud Logging进行日志和监控。

部署步骤

1. 增量更新https://github.com/jhipster/jhipster-online/blob/d61bdbc3b6354516756c57626455be180eb4352e/pom.xml#L8%E5%92%8Chttps://github.com/jhipster/jhipster-online/blob/d61bdbc3b6354516756c57626455be180eb4352e/package.json#L3%E4%B8%AD%E7%9A%84%E7%89%88%E6%9C%AC%E5%8F%B7%E3%80%82
2. 创建标签化发布：进入https://github.com/jhipster/jhipster-online/releases%EF%BC%8C%E7%BC%96%E8%BE%91%60github-actions%60%E5%88%9B%E5%BB%BA%E7%9A%84%E8%8D%89%E7%A8%BF%E3%80%82

帮助和项目贡献

本项目是https://github.com/jhipster%E7%9A%84%E4%B8%80%E9%83%A8%E5%88%86%EF%BC%8C%E9%81%B5%E5%BE%AAhttps://github.com/jhipster/generator-jhipster%E7%9A%84%E8%A7%84%E5%88%99%E3%80%82

问题、bug或功能请求

请遵循https://github.com/jhipster/jhipster-online/blob/main/CONTRIBUTING.md%E3%80%82

问题或帮助请求

请在Stack Overflow上使用"jhipster"标签发布问题：[***]

行为准则

与JHipster主项目相同：https://github.com/jhipster/jhipster-online/blob/main/CODE_OF_CONDUCT.md%E3%80%82