feature #25: simplify readme.md

Author: CodingCrush

Dockerfile

@@ -17,11 +17,11 @@ WORKDIR /opt/weeklyreport
 
 # Start wp-server container
 
-# docker run -d
+# docker run -d \
 #            --restart=unless-stopped \
 #            --name weeklyreport-server \
-#            --net=host \
+#            -p 8000:80 \
 #            -v /etc/localtime:/etc/localtime:ro \
 #            -v $PWD:/opt/weeklyreport \
 #            weeklyreport:0.2 \
-#            gunicorn wsgi:app --bind 0.0.0.0:8000 -w 2 --log-file logs/awsgi.log --log-level=DEBUG
+#            gunicorn wsgi:app --bind 0.0.0.0:80 -w 2 --log-file logs/awsgi.log --log-level=DEBUG

README.md

@@ -1,95 +1,56 @@
 截图及步骤请看
 http://codingcrush.me/2017/04/16/weekly-report/
 
-## 安装说明
-+ 配置数据库
-数据库没有限制，可选择使用sqlite，跳过数据库安装，方便快捷。
-```
-    SQLALCHEMY_DATABASE_URI = 'sqlite:///' + os.path.join(os.getcwd(), 'wr_prd.sqlite')
-```
-
-项目中集成了是docker化的postgres，cd到postgres目录下，pull镜像，启动container。
-数据库URI地址由数据库名、用户名、密码、主机、端口号构造。
-```
-SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:postgres@localhost/wr_prd'
-```
-
-```docker
-1.docker pull daocloud.io/postgres:9.6
-2.docker run -d \
-           --restart=always \
-           --name wr-postgres \
-           --net='host' \
-           -v /etc/localtime:/etc/localtime:ro \
-           -e "LANG=en_US.UTF-8" \
-           -v $PWD/pg96_data:/var/lib/postgresql/data \
-           -e POSTGRES_DB=wr_prd \
-           -e POSTGRES_USER=postgres \
-           -e POSTGRES_PASSWORD=postgres \
-           daocloud.io/postgres:9.6
-```
-
-+  配置nginx
-   必要性不大，可略过
-   
-+  配置config.py
-
-重命名config.py.sample为config.py并进行配置：
-
-`SECRET_KEY`随机产生，可以当做环境变量在初始化容器时注入
+## 配置说明
+ `-w <N>`为开启的gunicorn　worker进程数
 
-`FLASK_ADMIN_EMAIL `:修改管理员邮箱，使用这个邮箱注册的用户自动成为管理员
+```bash
+git clone https://github.com/CodingCrush/WeeklyReport && \
 
-`ProductionConfig:`此处需要根据不同的数据库构造SQLALCHEMY_DATABASE_URI
+cd WeeklyReport && \
 
-`DEPARTMENTS`:`这个元组存储着部门列表，根据初始化到数据库中，用户在注册时便可以选择部门。
+docker build -t weeklyreport:0.2 . && \
 
-`default: ProductionConfig`修改为生产环境配置，也可以用FLASK_CONFIG这个环境变量指定当前选择的环境，通常是docker启动时使用生产环境，自己在本地使用开发环境与SQLite进行修改调试
+docker run -d \
+        --restart=unless-stopped \
+        --name weeklyreport-server \
+        -p 8000:80 \
+        -v /etc/localtime:/etc/localtime:ro \
+        -v $PWD:/opt/weeklyreport \
+        weeklyreport:0.2 \
+        gunicorn wsgi:app --bind 0.0.0.0:80 -w 2 --log-file logs/awsgi.log --log-level=DEBUG
+```
 
-`MAIL_USERNAME` : 用来发送邮件通知的邮箱账号
+## 更新说明
+V0.2: 简化了部署步骤
 
-`MAIL_PASSWORD` : 密码
+## 配置说明
 
-+ 制作镜像
++ 配置数据库
+数据库默认使用sqlite，方便快捷。
 
-在weeklyreport目录下，运行
-```docker
-docker build -t weeklyreport:20170609 .
+或者可以使用postgres container，cd到postgres目录下，pull镜像，启动。
+数据库URI地址由数据库名、用户名、密码、主机、端口号构造。
 ```
-`yymmdd`是日期标签，自行修改。
-
-+ 启动container
+SQLALCHEMY_DATABASE_URI = 'postgresql://postgres:postgres@localhost/wr_prd'
+```
+步骤见postgres目录下的readme.md
 
- `<host>:<port>`为监听的ip与端口号
- 
- `-w <N>`为开启的gunicorn　worker进程数
++  配置config.py
 
-```docker
- docker run \
-            -d --restart=always \
-            --name wr-server \
-            --net='host' \
-            -v /etc/localtime:/etc/localtime:ro \
-            -v $PWD:/opt/weeklyreport \
-            weeklyreport:20170609 \
-            gunicorn wsgi:app --bind localhost:8000 -w 4 --log-file logs/awsgi.log --log-level=DEBUG
+修改config.py并进行配置：
 
-```
+`DEPARTMENTS`:`这个元组为部门列表，第一次打开时自动初始化到数据库中，用户在注册时可以选择部门。
 
-+ 数据库初始化
+`MAIL_USERNAME` : 用来发送邮件通知的邮箱账号
 
-这时打开localhost:8000会出现错误，因为还未初始化数据库，在bash中执行初始化deploy命令
-```bash
-docker exec weeklyreport-server bash -c 'python3.6 manage.py deploy'
-```
+`MAIL_PASSWORD` : 用来发送邮件通知的邮箱密码
 
-配置完成，注册用户吧
 
 ## 后台管理
 
-首先使用`FLASK_ADMIN_EMAIL`邮箱注册管理员账户，可以登录后台。
-
-以后其他用户注册后，可以指定角色。
+第一次注册的用户为超级管理员，永远有登录后台的权限。
+管理员可以修改其他角色
 
 默认用户角色为`EMPLOYEE`，仅具有读写自己的周报的权限，
 

postgres/README.md

@@ -1,14 +1,14 @@
 ## DEPLOYMENT
 
-    1. docker pull postgres:9.6
+    1. docker pull postgres:9.6.5
     2. docker run -d \
-           --restart=always \
+           --restart=unless-stopped \
            --name wr-postgres \
-           --net='host' \
+           -p 5432:5432 \
            -v /etc/localtime:/etc/localtime:ro \
            -e "LANG=en_US.UTF-8" \
            -v $PWD/pg96_data:/var/lib/postgresql/data \
            -e POSTGRES_DB=wr_prd \
            -e POSTGRES_USER=postgres \
            -e POSTGRES_PASSWORD=postgres \
-           postgres:9.6
+           postgres:9.6.5