【亲测免费】 PushDeer 项目安装与使用教程

1. 项目的目录结构及介绍

PushDeer 项目的目录结构如下：

pushdeer/
├── android/
├── api/
├── doc/
├── docker/
├── examples/
├── ios/
├── iot/
├── plugins/
├── push/
├── quickapp/
├── self-hosted-push-server/
├── .gitignore
├── LICENSE
├── README.md
├── RoboFile.php
├── docker-compose.self-hosted.yml
├── docker-compose.serverless.yml
└── docker-compose.yml

目录介绍

• android/：存放 Android 客户端的源代码。
• api/：包含 Laravel 实现的 API 接口。
• doc/：文档目录，包括界面设计源文件（Adobe XD）和资源文件（logo 和 avatar）。
• docker/：API 实现的 Docker 封装，一键启动，方便使用。
• examples/：示例代码目录。
• ios/：存放 iOS 客户端的源代码。
• iot/：物联网版本 DeerESP 的源代码。
• plugins/：插件目录，例如 WordPress 插件。
• push/：基于 gorush 架设的推送微服务。
• quickapp/：存放快应用的源代码。
• self-hosted-push-server/：自架版推送服务器的相关代码。
• .gitignore：Git 忽略文件配置。
• LICENSE：项目许可证文件。
• README.md：项目说明文件。
• RoboFile.php：Robo 任务文件。
• docker-compose.self-hosted.yml：自架版 Docker Compose 配置文件。
• docker-compose.serverless.yml：Serverless 版 Docker Compose 配置文件。
• docker-compose.yml：默认的 Docker Compose 配置文件。

2. 项目的启动文件介绍

PushDeer 项目的主要启动文件是 docker-compose.yml 和 docker-compose.self-hosted.yml。

docker-compose.yml

这是默认的 Docker Compose 配置文件，用于启动 PushDeer 的 API 服务。

version: '3'
services:
  api:
    image: pushdeer/api:latest
    ports:
      - "8800:8800"
    volumes:
      - ./api:/app
    environment:
      - APP_DEBUG=true
      - APP_ENV=local

docker-compose.self-hosted.yml

这是自架版的 Docker Compose 配置文件，用于在本地或私有服务器上部署 PushDeer 服务。

version: '3'
services:
  api:
    image: pushdeer/api:latest
    ports:
      - "8800:8800"
    volumes:
      - ./api:/app
    environment:
      - APP_DEBUG=true
      - APP_ENV=local
  push:
    image: pushdeer/push:latest
    ports:
      - "8088:8088"
    volumes:
      - ./push:/app

3. 项目的配置文件介绍

PushDeer 项目的主要配置文件包括 .env 文件和 docker-compose.yml 中的环境变量配置。

.env 文件

.env 文件通常位于 api/ 目录下，用于配置 Laravel 应用的环境变量。

APP_NAME=PushDeer
APP_ENV=local
APP_KEY=base64:your-app-key
APP_DEBUG=true
APP_URL=http://localhost:8800

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=pushdeer
DB_USERNAME=root
DB_PASSWORD=secret

docker-compose.yml 中的环境变量配置

在 docker-compose.yml 中，可以通过 environment 字段配置环境变量。

environment:
  - APP_DEBUG=true
  - APP_ENV=local
  - DB_CONNECTION=mysql
  - DB_HOST=db
  - DB_PORT=3306
  - DB_DATABASE=pushdeer
  - DB_USERNAME=root
  - DB_PASSWORD=secret

这些配置项用于控制应用的调试模式、环境类型以及数据库连接信息。

通过以上配置，您可以轻松启动 PushDeer 项目并进行自定义配置。