Merge pull request #70 from NKUST-ITC/develop

v3.0.0

Author: abc873693

.gitignore

@@ -225,11 +225,12 @@ leave_test.py
 test_page.html
 html/
 src/config.py
-src/gunicorn_cfg.py
 
 \.vscode/
 
 \.idea/
 caddy/Caddyfile
 \.env
-venv/
+venv/
+data/certbot/
+nginx_nkust_api.conf

Dockerfile

@@ -0,0 +1,15 @@
+FROM python:3.6
+# Create app directory
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+COPY . /usr/src/app
+
+RUN pip3 install -r ./requirements.txt
+
+RUN apt-get update && \
+    apt-get install -y nodejs
+
+WORKDIR src
+
+# RUN ["gunicorn","web-server:app"]

README.md

@@ -1,27 +1,175 @@
 [![Python 3.6](https://img.shields.io/badge/python-3.6-blue.svg)](https://www.python.org/downloads/release/python-360/)
 
-NKUST-AP-API
+
+ NKUST API Server(高雄科技大學 API Server)
 ==========
+* [Requirement](#requirement)
+* [API Docs](#api-docs)
+* [Quick start](#quick-start)
+   * [Using Python virtual enviroment & Gunicorn](#using-python-virtual-enviroment-&-gunicorn)
+   * [Using Docker-compose](#using-docker-compose)
+     
 
-高雄科技大學 API Server NKUST API Server
----------------------------
 Requirement
 ---
 - Ubuntu (18.04 or previous version)
 - Python 3.6
 - Redis server
 - NodeJS (if host by python venv)
 
-API Docs
+### [API Docs](https://github.com/NKUST-ITC/NKUST-AP-API/tree/gh-pages/docs)
+
+
+
+Quick start
 ---
-[API PAGE](https://nkust-itc.github.io/NKUST-AP-API/docs/api-page.html)
+### Using Python virtual enviroment & Gunicorn
+
+需要先在本地端設定/安裝好 [Redis server](https://redis.io/)
+
+如果Redis有自行調整Host或Port或是使用外部的Redis，需執行
+
+預設為本地的位置 `redis://127.0.0.1:6379` 執行
+
+```bash
+$ export REDIS_URL=redis://127.0.0.1:6666
+```
+
+若設定最新消息的管理員，可以透過`;`來新增多位管理員(非必須)
+
+```bash
+$ export NEWS_ADMIN="1106111111;1105293392"
+```
+
+或是設定一個帳號密碼，來登入管理員。
+
+```bash
+$ export NEWS_ADMIN_ACCOUNT="admin"
+$ export NEWS_ADMIN_PASSWORD="1234567"
+```
+
+創建Python virtual enviroment
 
-[docs](https://github.com/NKUST-ITC/AP-API/tree/develop/docs/v3)
+```bash
+$ python3 -m venv venv
+```
+
+啟動 virtual enviroment
+
+```bash
+$ source venv/bin/activate
+```
+
+安裝相關packages
+
+```bash
+$ pip3 install -r requirement.txt
+```
+
+啟動伺服器(Debug 模式)
+
+```bash
+$ gunicorn web-server:app
+```
+
+啟動伺服器(Release 模式)
+
+```bash
+$ gunicorn -c gunicorn_config.py web-server:app
+```
 
-Donate
 ---
-[![BitCoin donate
-button](http://img.shields.io/bitcoin/donate.png?color=yellow)](https://coinbase.com/checkouts/aa7cf80a2a85b4906cb98fc7b2aad5c5 "Donate
-once-off to this project using BitCoin")
 
 
+
+### Using Docker-compose (Production Stage)
+
+#### docker-compose中的docker image
+
+* [NKUST-AP-API](https://cloud.docker.com/u/nkustitc/repository/docker/nkustitc/nkust-ap-api/general)
+* Redis
+* Nginx
+* Certbot
+
+
+
+```bash
+$ cp env.example .env
+```
+
+如果有要設定`最新消息`的管理者，可以在`.env`中修改 `NEWS_ADMIN` 參數
+
+```
+REDIS_URL=redis://redis:6379
+```
+
+如需要更改redis位置，可以在`.env`中修改 `REDIS_URL` 參數，
+
+**這邊redis中的host是套用 `dokcer network` 的設定**
+
+```
+REDIS_URL=redis://redis:6379
+```
+
+複製 nginx 設定檔(HTTPS)
+
+```bash
+$ cp nginx/nginx_nkust_api.conf.Example nginx/nginx_nkust_api.conf
+```
+
+若需要單純使用 HTTP 則需複製 `nginx_nkust_api_http.conf.Example`
+
+```bash
+$ cp nginx/nginx_nkust_api_http.conf.Example nginx/nginx_nkust_api.conf
+```
+
+將`nginx_nkust_api_http.conf` 設定檔中 "**所有**"`example.org`取代為要目標的網域
+
+```
+2  server_name example.org;
+...
+17 server_name example.org;
+```
+更改為
+```
+2 server_name 目標網域;
+...
+17 server_name 目標網域;
+```
+
+### 註冊SSL憑證
+
+修改`init-letsencrypt.sh` `line 8~9` 中的網域及email
+
+```bash
+8 domains=(aaa.example.org aaa.example.org)
+9 email="[email protected]" 
+```
+
+給予shell sript 權限
+
+```bash
+$ sudo chmod +x init-letsencrypt.sh
+```
+
+並執行shell sript註冊，此過程會開啟伺服器
+
+```bash
+$ sudo ./init-letsencrypt.sh
+```
+
+後續再次開啟**不需要**使用`init-letsencrypt.sh` 
+
+最後執行docker-compose 開啟伺服器
+
+-d 為背景執行，若不需要可以不用加
+
+```bash
+$ docker-compose up -d 
+```
+
+#### Other port 
+
+如有其他port 的需求
+
+修改`nginx/nginx_nkust_api.conf` 像是一般的nginx設定檔案

docker-compose.yml

@@ -0,0 +1,58 @@
+version: "3.6"
+services:
+  web:
+    container_name: NKUST_AP_API
+    build:
+      context: .
+      dockerfile: Dockerfile
+    volumes:
+      - .:/usr/src/app
+    environment:
+      - REDIS_URL=${REDIS_URL}
+      - NEWS_ADMIN=${NEWS_ADMIN}
+      - NEWS_ADMIN_ACCOUNT=${NEWS_ADMIN_ACCOUNT}
+      - NEWS_ADMIN_PASSWORD=${NEWS_ADMIN_PASSWORD}
+    command: ["gunicorn", "-c", "gunicorn_cfg.py", "web-server:app"]
+    networks:
+      - redis-net
+      - open-net
+    depends_on:
+      - redis
+  redis:
+    image: "redis:alpine"
+    command: ["redis-server", "--appendonly", "yes"]
+    networks:
+      - redis-net
+    volumes:
+      - redis-data:/data
+
+  nginx:
+    image: nginx:latest
+    restart: unless-stopped
+    volumes:
+      - ./nginx/nginx_nkust_api.conf:/etc/nginx/conf.d/nginx_nkust_api.conf
+      - ./data/certbot/conf:/etc/letsencrypt
+      - ./data/certbot/www:/var/www/certbot
+    ports:
+      - "80:80"
+      - "443:443"
+    networks:
+      - open-net
+    depends_on:
+      - web
+      - certbot
+    command: '/bin/sh -c ''while :; do sleep 6h & wait $${!}; nginx -s reload; done & nginx -g "daemon off;"'''
+
+  certbot:
+    image: certbot/certbot
+    restart: unless-stopped
+    container_name: certbot
+    volumes:
+      - ./data/certbot/conf:/etc/letsencrypt
+      - ./data/certbot/www:/var/www/certbot
+    entrypoint: "/bin/sh -c 'trap exit TERM; while :; do certbot renew; sleep 12h & wait $${!}; done;'"
+networks:
+  redis-net:
+  open-net:
+volumes:
+  redis-data: