# code-push-server **Repository Path**: xinlc/code-push-server ## Basic Information - **Project Name**: code-push-server - **Description**: CodePush service is hot update services which adapter react-native-code-push and cordova-plugin-code-push - 热更新 - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2019-06-18 - **Last Updated**: 2024-04-27 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # CodePush Server [source](https://github.com/lisong/code-push-server) [![NPM](https://nodei.co/npm/code-push-server.svg?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/code-push-server/) [![NPM Version](https://img.shields.io/npm/v/code-push-server.svg)](https://npmjs.org/package/code-push-server) [![Node.js Version](https://img.shields.io/node/v/code-push-server.svg)](https://nodejs.org/en/download/) [![Linux Status](https://img.shields.io/travis/lisong/code-push-server/master.svg?label=linux)](https://travis-ci.org/lisong/code-push-server) [![Windows Status](https://img.shields.io/appveyor/ci/lisong/code-push-server/master.svg?label=windows)](https://ci.appveyor.com/project/lisong/code-push-server) [![Coverage Status](https://img.shields.io/coveralls/lisong/code-push-server/master.svg)](https://coveralls.io/github/lisong/code-push-server) [![Dependency Status](https://img.shields.io/david/lisong/code-push-server.svg)](https://david-dm.org/lisong/code-push-server) [![Known Vulnerabilities](https://snyk.io/test/npm/code-push-server/badge.svg)](https://snyk.io/test/npm/code-push-server) [![Licenses](https://img.shields.io/npm/l/code-push-server.svg)](https://spdx.org/licenses/MIT) CodePush Server is a CodePush progam server! microsoft CodePush cloud is slow in China, we can use this to build our's. I use [qiniu](http://www.qiniu.com/) to store the files, because it's simple and quick! Or you can use local storage, just modify config.js file, it's simple configure. ## qq交流群 - 628921445 - 535491067 ## 正确使用code-push热更新 - 苹果允许使用热更新[Apple's developer agreement](https://developer.apple.com/programs/ios/information/iOS_Program_Information_4_3_15.pdf), 但是规定不能弹框提示用户更新，影响用户体验。 而Google Play恰好相反，必须弹框告知用户更新。然而中国的android市场都必须关闭更新弹框，否则会在审核应用时以“请上传最新版本的二进制应用包”驳回应用。 - react-native 不同平台bundle包不一样，在使用code-push-server的时候必须创建不同的应用来区分(eg. CodePushDemo-ios 和 CodePushDemo-android) - react-native-code-push只更新资源文件,不会更新java和Objective C，所以npm升级依赖包版本的时候，如果依赖包使用的本地化实现, 这时候必须更改应用版本号(ios修改Info.plist中的CFBundleShortVersionString, android修改build.gradle中的versionName), 然后重新编译app发布到应用商店。 - 推荐使用code-push release-react 命令发布应用，该命令合并了打包和发布命令(eg. code-push release-react CodePushDemo-ios ios -d Production) - 每次向App Store提交新的版本时，也应该基于该提交版本同时向code-push-server发布一个初始版本。(因为后面每次向code-push-server发布版本时，code-puse-server都会和初始版本比较，生成补丁版本) ## EXAMPLE api.code-push.com 只是一个测试server，不要将自己生产环境的项目放在上面，服务器的宽带只有1M，而且服务没有做负载均衡和监控，稳定性不能保证，烦请大家自己搭建自己的服务。 ### shell命令行端 ```shell $ code-push login http://api.code-push.com #登录 ``` ### [web](http://www.code-push.com) 访问：http://www.code-push.com ### 客户端eg. [ReactNative CodePushDemo](https://github.com/lisong/code-push-demo-app) [Cordova CodePushDemo](https://github.com/lisong/code-push-cordova-demo-app) ## INSTALL FROM NPM PACKAGE ```shell $ npm install code-push-server -g $ code-push-server-db init --dbhost localhost --dbuser root --dbpassword #初始化mysql数据库 $ code-push-server #启动服务 浏览器中打开 http://127.0.0.1:3000 ``` ## INSTALL FROM SOURCE CODE ```shell $ git clone https://github.com/lisong/code-push-server.git $ cd code-push-server $ npm install $ ./bin/db init --dbhost localhost --dbuser root --dbpassword #初始化mysql数据库 $ ./bin/www #启动服务 浏览器中打开 http://127.0.0.1:3000 ``` ## UPGRADE *from source code* ```shell $ cd /path/to/code-push-server $ git pull --rebase origin master $ ./bin/db upgrade --dbhost localhost --dbuser root --dbpassword #升级codepush数据库 $ #restart code-push-server ``` *from npm package* ```shell $ code-push-server-db upgrade --dbhost localhost --dbuser root --dbpassword #升级codepush数据库 $ #restart code-push-server ``` ## CONFIG ```shell $ vim config/config.js ``` 请检查如下配置是否和你的环境一致,尤其是downloadUrl参数 ``` db: { username: "root", password: null, database: "codepush", host: "127.0.0.1", dialect: "mysql" }, //七牛云存储配置 当storageType为qiniu时需要配置 qiniu: { accessKey: "", secretKey: "", bucketName: "", downloadUrl: "" //文件下载域名地址 }, //阿里云存储配置 当storageType为oss时需要配置 oss: { accessKeyId: "", secretAccessKey: "", endpoint: "", bucketName: "", prefix: "", // 对象Key的前缀，允许放到子文件夹里面 downloadUrl: "", // 文件下载域名地址，需要包含前缀 }, //文件存储在本地配置 当storageType为local时需要配置 local: { storageDir: "/Users/tablee/workspaces/storage", //文件下载地址 CodePush Server 地址 + '/download' download对应app.js里面的地址 downloadUrl: "http://localhost:3000/download", // public static download spacename. public: '/download' }, jwt: { // 登录jwt签名密钥，必须更改，否则有安全隐患，可以使用随机生成的字符串 // Recommended: 63 random alpha-numeric characters // Generate using: https://www.grc.com/passwords.htm tokenSecret: 'INSERT_RANDOM_TOKEN_KEY' }, common: { dataDir: "/Users/tablee/workspaces/data", //选择存储类型，目前支持local,oss,qiniu,s3配置 storageType: "local" }, ``` read [config.js](https://github.com/lisong/code-push-server/blob/master/config/config.js) ## Storage mode [local/qiniu/s3] - 配置local存储,修改config/config.js中storageType值为local,配置中local下面storageDir和downloadUrl，如果不在同一台机器上，downloadUrl请指定域名或者ip地址 ## RUN ```shell $ node ./bin/www # or code-push-server ``` or point config file and ENV ```shell $ CONFIG_FILE=/path/to/config.js NODE_ENV=production node ./bin/www # or CONFIG_FILE=/path/to/config.js NODE_ENV=production code-push-server ``` notice. you have to change `tokenSecret` in config.js for security. ## Default listen Host/Port 0.0.0.0/3000 you can change like this. ```shell $ PORT=3000 HOST=127.0.0.1 NODE_ENV=production node ./bin/www # or PORT=3000 HOST=127.0.0.1 NODE_ENV=production code-push-server ``` ## [code-push-cli](https://github.com/Microsoft/code-push) Use code-push-cli manager CodePushServer ```shell $ npm install code-push-cli@latest -g $ code-push login http://127.0.0.1:3000 #login in browser account:admin password:123456 ``` change admin password eg. ```shell $ curl -X PATCH -H "Authorization: Bearer mytoken" -H "Accept: application/json" -H "Content-Type:application/json" -d '{"oldPassword":"123456","newPassword":"654321"}' http://127.0.0.1:3000/users/password ``` ## [react-native-code-push](https://github.com/Microsoft/react-native-code-push) for react-native ```shell $ cd /path/to/project $ npm install react-native-code-push@latest --save ``` ## config react-native project Follow the react-native-code-push docs, addition iOS add a new entry named CodePushServerURL, whose value is the key of ourself CodePushServer URL. Andriod use the new CodePush constructor in MainApplication point CodePushServerUrl iOS eg. in file Info.plist ```xml ... CodePushDeploymentKey YourCodePushKey CodePushServerURL YourCodePushServerUrl ... ``` Android eg. in file MainApplication.java ```java @Override protected List getPackages() { return Arrays.asList( new MainReactPackage(), new CodePush( "YourKey", MainApplication.this, BuildConfig.DEBUG, "YourCodePushServerUrl" ) ); } ``` ## [cordova-plugin-code-push](https://github.com/Microsoft/cordova-plugin-code-push) for cordova ```shell $ cd /path/to/project $ cordova plugin add cordova-plugin-code-push@latest --save ``` ## config cordova project edit config.xml. add code below. ```xml ``` ## Production Manage use [pm2](http://pm2.keymetrics.io/) to manage process. ```shell $ npm install pm2 -g $ cp config/config.js /path/to/production/config.js $ vim /path/to/production/config.js #configure your env. $ cp docs/process.json /path/to/production/process.json $ vim /path/to/production/process.json #configure your env. $ pm2 start /path/to/production/process.json ``` ## Use [CodePush Web](https://github.com/lisong/code-push-web) manage apps add codePushWebUrl config in ./config/config.js eg. ```json ... "common": { "codePushWebUrl": "Your CodePush Web address", } ... ``` ## License MIT License [read](https://github.com/lisong/code-push-server/blob/master/LICENSE)