Update docker one-click deployment (#88)

* Update the docker-compose deployment directory and internals

* missed updates

* update readme style

Author: wu-clan

Dockerfile

@@ -2,7 +2,7 @@ FROM python:3.10-slim
 
 WORKDIR /fba
 
-COPY . /fba
+COPY . .
 
 RUN sed -i s@/deb.debian.org/@/mirrors.aliyun.com/@g /etc/apt/sources.list \
     && sed -i s@/security.debian.org/@/mirrors.aliyun.com/@g /etc/apt/sources.list
@@ -11,15 +11,16 @@ RUN apt-get update \
     && apt-get install -y --no-install-recommends gcc python3-dev \
     && rm -rf /var/lib/apt/lists/*
 
-RUN pip install --upgrade pip -i https://pypi.tuna.tsinghua.edu.cn/simple \
-    && pip install --no-cache-dir -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple
+# 某些包可能存在同步不及时导致安装失败的情况，可选择备用源
+# 清华源（国内快，也可能同步不及时）：https://pypi.tuna.tsinghua.edu.cn/simple
+# 官方源（国外慢，但永远都是最新的）：https://pypi.org/simple
+RUN pip install --upgrade pip -i https://mirrors.aliyun.com/pypi/simple \
+    && pip install --no-cache-dir -r requirements.txt -i https://mirrors.aliyun.com/pypi/simple
 
 ENV TZ = Asia/Shanghai
 
 RUN mkdir -p /var/log/fastapi_server
 
-RUN cd /fba && touch .env
-
 EXPOSE 8001
 
 CMD ["uvicorn", "backend.app.main:app", "--host", "127.0.0.1", "--port", "8000"]

README.md

@@ -2,10 +2,9 @@
 
 English | [简体中文](./README.zh-CN.md)
 
-This is a base project of the FastAPI framework, in production
+This is a basic project of the FastAPI framework, using a pseudo three-tier architecture, **still in production**
 
-It‘s purpose is to allow you to develop your project directly with it
-as your base project
+It‘s purpose is to allow you to develop your project directly with it as your base project
 
 Support python3.10 and above
 
@@ -15,6 +14,7 @@ Support python3.10 and above
 - [x] Pydantic
 - [x] SQLAlchemy
 - [x] Alembic
+- [x] Casbin
 - [x] MySQL
 - [x] Redis
 - [x] APScheduler
@@ -32,49 +32,62 @@ git clone https://github.com/wu-clan/fastapi_best_architecture.git
 
 1. Install dependencies
 
-    ```shell
-    pip install -r requirements.txt
-    ```
+   ```shell
+   pip install -r requirements.txt
+   ```
 
 2. Create a database `fba`, choose utf8mb4 encode
 3. Install and start Redis
 4. create a `.env` file in the `backend/app/` directory
 
-    ```shell
-    cd backend/app/
-   
-    touch .env
-    ```
+   ```shell
+   cd backend/app/
 
-5. Copy `.env.example` to `.env` and view `backend/app/core/conf.py`, update database configuration information
+   touch .env
+   ```
+
+5. Copy `.env.example` to `.env`
+
+   ```shell
+   cp .env.example .env
+   ```
+
 6. Perform a database migration [alembic](https://alembic.sqlalchemy.org/en/latest/tutorial.html)
 
-    ```shell
-    cd backend/app/
-    
-    # Generate the migration file
-    alembic revision --autogenerate
-    
-    # Perform the migration
-    alembic upgrade head
-    ```
+   ```shell
+   cd backend/app/
 
+   # Generate the migration file
+   alembic revision --autogenerate
+   
+   # Perform the migration
+   alembic upgrade head
+   ```
+
 7. Execute the `backend/app/main.py` file startup service
 8. Browser access: http://127.0.0.1:8000/v1/docs
 
 ---
 
 ### 2：Docker
 
-1. Run the one-click start command in the directory where the `docker-compose.yml` file is located
+1. Go to the directory where the `docker-compose.yml` file is located and create the environment variable file `.env`
 
-    ```shell
-    docker-compose up -d --build
-    ```
+   ```shell
+   cp .env.server ../../backend/app/.env   
 
-2. Wait for the command to finish automatically
+   # This command is optional
+   cp .env.docker .env
+   ```
+
+2. Execute the one-click start command
 
-3. Browser access: http://127.0.0.1:8000/v1/docs
+   ```shell
+   docker-compose up -d -build
+   ```
+
+3. Wait for the command to finish automatically
+4. Browser access: http://127.0.0.1:8000/v1/docs
 
 ## Init the test data
 
@@ -85,13 +98,12 @@ Execute the `backend/app/init_test_data.py` file
 Perform tests via pytest
 
 1. Create a database `fba_test`, choose utf8mb4 encode
-
 2. First, go to the app directory
 
    ```shell
    cd backend/app/
    ```
-   
+
 3. Init the test data
 
    ```shell

README.zh-CN.md

@@ -2,7 +2,7 @@
 
 简体中文 | [English](./README.md)
 
-这是 FastAPI 框架的一个基础项目，在制作中
+这是 FastAPI 框架的一个基础项目，使用伪三层架构，**目前还在制作中**
 
 它的目的是让你直接用它作为你的基础项目来开发你的项目
 
@@ -14,6 +14,7 @@
 - [x] Pydantic
 - [x] SQLAlchemy
 - [x] Alembic
+- [x] Casbin
 - [x] MySQL
 - [x] Redis
 - [x] APScheduler
@@ -37,12 +38,20 @@ git clone https://github.com/wu-clan/fastapi_best_architecture.git
 2. 创建一个数据库`fba`，选择 utf8mb4 编码
 3. 安装并启动 Redis
 4. 在`backend/app/`目录下创建一个`.env`文件
+
     ```shell
     cd backend/app/
     touch .env
     ```
-5. 复制 `.env.example` 到 `.env` 并查看`backend/app/core/conf.py`，更新数据库配置信息
+
+5. 复制 `.env.example` 到 `.env`
+
+   ```shell
+   cp .env.example .env
+   ```
+
 6. 进行数据库迁移[alembic](https://alembic.sqlalchemy.org/en/latest/tutorial.html)
+
    ```shell
    cd backend/app/
 
@@ -52,22 +61,31 @@ git clone https://github.com/wu-clan/fastapi_best_architecture.git
    # 执行迁移
    alembic upgrade head
     ```
+
 7. 执行 `backend/app/main.py` 文件启动服务
 8. 浏览器访问：http://127.0.0.1:8000/v1/docs
 
 ---
 
 ### 2：Docker
 
-1. 在 `docker-compose.yml` 文件所在的目录中运行一键启动命令
+1. 进入 `docker-compose.yml` 文件所在目录，创建环境变量文件`.env`
+
+   ```shell
+   cp .env.server ../../backend/app/.env
+   
+   # 此命令为可选
+   cp .env.docker .env
+   ```
+
+2. 执行一键启动命令
 
    ```shell
    docker-compose up -d -build
    ```
-   
-2. 等待命令自动完成
 
-3. 浏览器访问：http://127.0.0.1:8000/v1/docs
+3. 等待命令自动完成
+4. 浏览器访问：http://127.0.0.1:8000/v1/docs
 
 ## 初始化测试数据
 
@@ -78,13 +96,12 @@ git clone https://github.com/wu-clan/fastapi_best_architecture.git
 通过 pytest 进行测试
 
 1. 创建一个数据库`fba_test`，选择 utf8mb4 编码
-
 2. 首先，进入app目录
 
    ```shell
    cd backend/app/
    ```
-   
+
 3. 初始化测试数据
 
    ```shell

deploy/docker-compose/.env.docker

@@ -0,0 +1,3 @@
+# Docker
+DOCKER_DB_MAP_PORT=13306
+DOCKER_REDIS_MAP_PORT=16379

.env.docker renamed to deploy/docker-compose/.env.server

@@ -1,17 +1,17 @@
 # Env: dev、pro
 ENVIRONMENT='dev'
 # MySQL
-DB_HOST='mysql'
+DB_HOST='fba_mysql'
 DB_PORT=3306
 DB_USER='root'
 DB_PASSWORD='123456'
 # Redis
-REDIS_HOST='redis'
+REDIS_HOST='fba_redis'
 REDIS_PORT=6379
 REDIS_PASSWORD=''
 REDIS_DATABASE=0
 # APScheduler
-APS_REDIS_HOST='redis'
+APS_REDIS_HOST='fba_redis'
 APS_REDIS_PORT=6379
 APS_REDIS_PASSWORD=''
 APS_REDIS_DATABASE=1

docker-compose.yml renamed to deploy/docker-compose/docker-compose.yml

@@ -1,40 +1,51 @@
 version: "3.10"
 
+networks:
+  fba_network:
+    driver: bridge
+    ipam:
+      driver: default
+      config:
+        - subnet: 172.10.10.0/24
+
+volumes:
+  fba_mysql:
+  fba_redis:
+  fba_static:
+
 services:
-  app:
+  fba_server:
     build:
-      context: .
+      context: ../../
       dockerfile: Dockerfile
     container_name: "fba_server"
     restart: always
     depends_on:
-      - mysql
-      - redis
+      - fba_mysql
+      - fba_redis
     volumes:
-      - ./backend:/fba/backend
-      - .env.docker:/fba/backend/app/.env
       - fba_static:/fba/backend/app/static
     networks:
       - fba_network
     command:
       - bash
       - -c
       - |
-        wait-for-it -s mysql:3306 -s redis:6379 -t 300
-        supervisord -c supervisor.conf
+        wait-for-it -s fba_mysql:3306 -s fba_redis:6379 -t 300
+        supervisord -c /fba/deploy/supervisor.conf
 
-  mysql:
+  fba_mysql:
     image: mysql:8.0.29
     ports:
-      - "3306:3306"
-    container_name: "mysql"
+      - "${DOCKER_DB_MAP_PORT:-3306}:3306"
+    container_name: "fba_mysql"
     restart: always
     environment:
       MYSQL_DATABASE: fba
       MYSQL_ROOT_PASSWORD: 123456
       TZ: Asia/Shanghai
     volumes:
-      - /var/lib/mysql
+      - fba_mysql:/var/lib/mysql
     networks:
       - fba_network
     command:
@@ -43,36 +54,29 @@ services:
       --collation-server=utf8mb4_general_ci
       --lower_case_table_names=1
 
-  redis:
+  fba_redis:
     image: redis:6.2.7
     ports:
-      - "6379:6379"
-    container_name: "redis"
+      - "${DOCKER_REDIS_MAP_PORT:-6379}:6379"
+    container_name: "fba_redis"
     restart: always
     environment:
       - TZ=Asia/Shanghai
     volumes:
-      - /var/lib/redis
+      - fba_redis:/var/lib/redis
     networks:
       - fba_network
 
-  nginx:
+  fba_nginx:
     image: nginx
     ports:
       - "8000:80"
-    container_name: "nginx"
+    container_name: "fba_nginx"
     restart: always
     depends_on:
-      - app
+      - fba_server
     volumes:
-      - ./nginx.conf:/etc/nginx/nginx.conf:ro
+      - ../nginx.conf:/etc/nginx/nginx.conf:ro
       - fba_static:/www/fba/backend/app/static
     networks:
       - fba_network
-
-
-networks:
-  fba_network:
-
-volumes:
-  fba_static:

gunicorn.conf.py renamed to deploy/gunicorn.conf.py

@@ -40,7 +40,7 @@ http {
         client_max_body_size   10m;  # 最大上传文件
 
         location / {
-                proxy_pass http://app:8001;
+                proxy_pass http://fba_server:8001;
 
                 proxy_set_header Host $http_host;
                 proxy_set_header X-Real-IP $remote_addr;

nginx.conf renamed to deploy/nginx.conf

@@ -156,10 +156,10 @@ serverurl=unix:///tmp/supervisor.sock ; use a unix:// URL  for a unix socket
 
 [program:fastapi_server]
 directory=/fba
-command=/usr/local/bin/gunicorn -c gunicorn.conf.py main:app
+command=/usr/local/bin/gunicorn -c /fba/deploy/gunicorn.conf.py main:app
 user=root
 autostart=true
 autorestart=true
 startretries=5
 redirect_stderr=true
-stdout_logfile=/var/log/fastapi_server/fastapi_server.log
+stdout_logfile=/var/log/fastapi_server/fba_server.log