chore: add docs for login and access token issuance

Author: plingdevelop

README.cn.md

@@ -47,6 +47,19 @@
 -   帐号: `admin`
 -   密码: `123456`
 
+## 登录并获取访问令牌
+
+```sh
+code-push login https://<codepush-server-url>
+```
+
+-   运行以上命令后将打开浏览器 → 登录账号 → 生成访问令牌
+-   令牌生成后，请将其输入回 CLI 终端以完成登录
+-   WEB_UI_WHITELIST_IPS：允许访问 Web UI 的 IP 白名单（逗号分隔）
+    例如：127.0.0.1,10.0.0.1
+-   访问令牌的有效期为 30 天。
+-   WEB_UI_ALLOW：仅当该值设置为 true 时，才允许访问 Web UI
+
 ## 常见问题
 
 -   [修改密码](https://github.com/lisong/code-push-server/issues/43)
@@ -59,3 +72,7 @@
     -   `>=1.2.3 <1.2.7`
     -   `~1.2.3`
     -   `^1.2.3`
+
+```
+
+```

README.ko.md

@@ -89,6 +89,18 @@ Microsoft 공식 CodePush 서비스는 아시아 지역에서 속도가 느린 
 -   계정: `admin`
 -   비밀번호: `123456`
 
+## 로그인 및 엑세스 토큰 발급하기
+
+```sh
+code-push login https://<codepush-server-url>
+```
+
+-   위 커맨드를 통해 웹브라우저 오픈하기
+-   토큰 발급 후 CLI 터미널에 입력
+-   토큰 유효기간은 약 30일
+-   WEB_UI_WHITELIST_IPS: e.g., 127.0.0.1,10.0.0.1
+-   WEB_UI_ALLOW: true인 경우에만 웹브라우저 UI 노출 허용
+
 ## FAQ
 
 -   [비밀번호 변경](https://github.com/lisong/code-push-server/issues/43)

README.md

@@ -49,6 +49,19 @@ check out the [code-push-cli](https://github.com/shm-open/code-push-cli) which w
 -   account: `admin`
 -   password: `123456`
 
+## Login and Access Token Issuance
+
+```sh
+code-push login https://<codepush-server-url>
+```
+
+-   Run the command above to open the web browser → authenticate → issue an access token
+-   After the token is issued, enter it back into the CLI terminal when prompted
+-   The access token is valid for 30 days.
+-   WEB_UI_WHITELIST_IPS: Comma-separated list of allowed IP addresses
+    e.g. 127.0.0.1,10.0.0.1
+-   WEB_UI_ALLOW: Web UI access is enabled only when this value is set to true
+
 ## FAQ
 
 -   [modify password](https://github.com/lisong/code-push-server/issues/43)

src/core/services/account-manager.ts

@@ -69,7 +69,7 @@ class AccountManager {
         });
     }
 
-    isExsitAccessKeyName(uid: number, friendlyName: string) {
+    isExistAccessKeyName(uid: number, friendlyName: string) {
         return UserTokens.findOne({
             where: { uid, name: friendlyName },
         });

src/routes/accessKeys.ts

@@ -12,11 +12,11 @@ export const accessKeysRouter = express.Router();
 accessKeysRouter.get('/', checkToken, (req: Req, res, next) => {
     const { logger } = req;
     const uid = req.users.id;
-    logger.info('try get acceesKeys', { uid });
+    logger.info('try get accessKeys', { uid });
     accountManager
         .getAllAccessKeyByUid(uid)
         .then((accessKeys) => {
-            logger.info('get acceesKeys success', { uid });
+            logger.info('get accessKeys success', { uid });
             res.send({ accessKeys });
         })
         .catch((e) => {
@@ -44,15 +44,16 @@ accessKeysRouter.post(
         const uid = req.users.id;
         const createdBy = _.trim(body.createdBy);
         const friendlyName = _.trim(body.friendlyName);
-        const ttl = parseInt(body.ttl, 10);
+        // TODO: 엑세스토큰 만료일을 수정하고 싶은 경우 tokens.pug 에서 전송되는 ttl을 수정
+        const ttl = parseInt(body.ttl, 10); // 현재 호출부 기본값 30일 = 60*60*24*30*1000
         const description = _.trim(body.description);
         logger.info('try to generate access key', {
             uid,
             name: friendlyName,
             body: JSON.stringify(body),
         });
         return accountManager
-            .isExsitAccessKeyName(uid, friendlyName)
+            .isExistAccessKeyName(uid, friendlyName)
             .then((data) => {
                 if (!_.isEmpty(data)) {
                     throw new AppError(`The access key "${friendlyName}"  already exists.`);

src/routes/index.ts

@@ -9,7 +9,7 @@ export const indexRouter = express.Router();
 /**
  * 프로덕션 레벨 미들웨어 적용
  * - ipWhitelistOnly: IP주소 검사
- * - webUiGuard: NODE_ENV='production' OR ALLOW_REGISTRATION='true'
+ * - webUiGuard: WEB_UI_ALLOW='true'
  */
 indexRouter.get('/', [ipWhitelistOnly, webUiGuard], (req, res) => {
     res.render('index', { title: 'CodePushServer' });

views/tokens.pug

@@ -33,7 +33,7 @@ block js
         createdBy = 'Login-' + time;
       }
 
-      // TODO: make ttl and friendlyNamee configurable
+      // TODO: make ttl and friendlyName configurable
       var postParams = {
         createdBy: createdBy,
         friendlyName: "Login-" + time,