{"id":13821629,"url":"https://github.com/jinfeijie/yapi","last_synced_at":"2025-05-16T12:33:57.394Z","repository":{"id":37663992,"uuid":"173550877","full_name":"jinfeijie/yapi","owner":"jinfeijie","description":"Docker for YApi 一键部署YApi","archived":true,"fork":false,"pushed_at":"2022-03-24T06:11:53.000Z","size":34,"stargazers_count":304,"open_issues_count":2,"forks_count":130,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-19T21:36:15.289Z","etag":null,"topics":["docker-yapi","yapi","yapi-deploy"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jinfeijie.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-03T08:42:55.000Z","updated_at":"2024-10-24T03:36:54.000Z","dependencies_parsed_at":"2022-07-12T16:42:35.248Z","dependency_job_id":null,"html_url":"https://github.com/jinfeijie/yapi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinfeijie%2Fyapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinfeijie%2Fyapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinfeijie%2Fyapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jinfeijie%2Fyapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jinfeijie","download_url":"https://codeload.github.com/jinfeijie/yapi/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254530940,"owners_count":22086696,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-yapi","yapi","yapi-deploy"],"created_at":"2024-08-04T08:01:24.998Z","updated_at":"2025-05-16T12:33:57.098Z","avatar_url":"https://github.com/jinfeijie.png","language":"Shell","readme":"\u003ch2 align=\"center\"\u003eDocker for YApi\u003c/h2\u003e\n\u003cp align=\"center\"\u003e一键部署YApi\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://travis-ci.org/jinfeijie/yapi\"\u003e\u003cimg src=\"https://travis-ci.org/jinfeijie/yapi.svg?branch=master\" alt=\"Build Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://cloud.docker.com/u/mrjin/repository/docker/mrjin/yapi\"\u003e\u003cimg src=\"https://img.shields.io/docker/automated/mrjin/yapi.svg?style=flat-square\" alt=\"\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/jinfeijie/yapi\"\u003e\u003cimg src=\"https://img.shields.io/github/license/jinfeijie/yapi.svg?style=flat-square\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## ⚠️注意\n⚠️注意：本仓库目前只支持安装，暂不支持升级，请知晓。如需升级请备份mongoDB内的数据。\n\n## 使用\n默认密码是：`ymfe.org`，安装成功后进入后台修改\n\n## 可修改变量\n| 环境变量       | 默认值         | 建议         |\n| ------------- |:-------------:|:-----------:|\n| VERSION | 1.10.2  | *强烈建议升级*   |\n| HOME | /home | 可修改 |  \n| PORT | 3000  | 可修改 | \n| ADMIN_EMAIL | test@test.com  | 建议修改 | \n| DB_SERVER | mongo(127.0.0.1)  | 不建议修改 |\n| DB_NAME | yapi  | 不建议修改 |\n| DB_PORT | 27017 | 不建议修改|\n| VENDORS | ${HOME}/vendors | 不建议修改  | \n\n\n## 获取本镜像\n🚘获取本镜像：`docker pull mrjin/yapi:latest`\n\n## docker-compose 部署\n```\nversion: '2.1'\nservices:\n  yapi:\n    image: mrjin/yapi:latest\n    # build: ./\n    container_name: yapi\n    environment:\n      - VERSION=1.10.2\n      - LOG_PATH=/tmp/yapi.log\n      - HOME=/home\n      - PORT=3000\n      - ADMIN_EMAIL=test@test.com\n      - DB_SERVER=mongo\n      - DB_NAME=yapi\n      - DB_PORT=27017\n    # restart: always\n    ports:\n      - 127.0.0.1:3000:3000\n    volumes:\n      - ~/data/yapi/log/yapi.log:/home/vendors/log # log dir\n    depends_on:\n      - mongo\n    entrypoint: \"bash /wait-for-it.sh mongo:27017 -- entrypoint.sh\"\n    networks:\n      - back-net\n  mongo:\n    image: mongo\n    container_name: mongo\n    # restart: always\n    ports:\n      - 127.0.0.1:27017:27017\n    volumes:\n      - ~/data/yapi/mongodb:/data/db #db dir\n    networks:\n      - back-net\nnetworks:\n  back-net:\n    external: true\n```\n\n## Nginx 配置\n```\nserver {\n    listen     80;\n    server_name your.domain;\n    keepalive_timeout   70;\n\n    location / {\n        proxy_pass http://yapi:3000;\n    }\n    location ~ /\\. {\n        deny all;\n    }\n}\n```\n\n## 启动方法\n\n1. 修改`docker-compose.yml`文件里面相关参数\n\n2. 创建network：`docker network create back-net`\n\n3. 启动服务：`docker-compose up -d`\n\n✨欢迎 Star \u0026\u0026 Fork\n","funding_links":[],"categories":["Shell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjinfeijie%2Fyapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjinfeijie%2Fyapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjinfeijie%2Fyapi/lists"}