diff --git a/README.md b/README.md index 275804086975e71cc989a1a68b875be033d61793..2bac2826bb6e864759e9e4697764906d9f0b82f4 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,58 @@ + + # docker -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} +## 项目介绍 + +本项目托管于 Gitee,地址:https://gitee.com/docker_3/docker + +## 软件架构 + +本项目使用 Docker 容器化技术架构。 + +## 安装教程 + +### 前置要求 + +- Docker 引擎 20.10+ +- Docker Compose 2.0+ (可选) + +### 构建与运行 + +```bash +# 构建镜像 +docker build -t docker-app . -#### 软件架构 -软件架构说明 +# 运行容器 +docker run -d -p 8080:8080 --name my-app docker-app +``` +### 使用 Docker Compose (可选) -#### 安装教程 +```bash +docker-compose up -d +``` -1. xxxx -2. xxxx -3. xxxx +## 使用说明 -#### 使用说明 +1. 容器启动后,应用程序默认运行在端口 8080 +2. 可通过 `http://localhost:8080` 访问 +3. 日志查看:`docker logs my-app` -1. xxxx -2. xxxx -3. xxxx +## 配置说明 -#### 参与贡献 +| 环境变量 | 说明 | 默认值 | +|---------|------|--------| +| PORT | 服务端口 | 8080 | +| HOST | 服务地址 | 0.0.0.0 | -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +## 参与贡献 +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 创建 Pull Request -#### 特技 +## 许可证 -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +本项目采用 MIT 许可证开源。 \ No newline at end of file