oanhnn/laravel-echo-server

oanhnn/laravel-echo-server

基于Alpine的https://github.com/tlaverdure/laravel-echo-server%E9%95%9C%E5%83%8F%E3%80%82

https://github.com/oanhnn/docker-laravel-echo-server/blob/master/.github/README-vi.md

https://github.com/oanhnn/docker-laravel-echo-server/workflows/CI/badge.svg](https://github.com/oanhnn/docker-laravel-echo-server/actions)

核心功能和特性

• 基于官方NodeJS镜像构建
• 安装最新版laravel-echo-server
• 遵循语义化版本进行标签管理
• 自动生成配置文件
• 通过Github Workflow自动构建和推送

镜像标签

镜像 oanhnn/laravel-echo-server

• X.Y.Z - 补丁版本（对应git标签 vX.Y.Z）
• X.Y - 次要版本
• X - 主要版本
• latest - 最新版本

镜像 ghcr.io/oanhnn/laravel-echo-server

• edge - 开发版本，包含master分支的最新代码
• nightly - 每日构建版本，UTC时间每天8:20构建

注意：生产环境建议使用语义化版本标签

环境要求

• Docker Engine 1.13+

使用方法和配置说明

运行laravel-echo-server

通过以下命令运行laravel-echo-server：

bash
$ docker run -d -p 6001:6001 -v $(pwd):/app oanhnn/laravel-echo-server

运行laravel-echo-server子命令

bash
$ docker run --rm -it -v $(pwd):/app oanhnn/laravel-echo-server init
$ docker run --rm -it -v $(pwd):/app oanhnn/laravel-echo-server start
$ docker run --rm -it -v $(pwd):/app oanhnn/laravel-echo-server client:add
$ docker run --rm -it -v $(pwd):/app oanhnn/laravel-echo-server client:remove

使用docker-compose运行

示例配置可参考examples文件夹。

自动生成配置文件

• 若/app/laravel-echo-server.json已存在，则直接加载该配置

• 若/app/laravel-echo-server.json不存在，将根据https://github.com/tlaverdure/laravel-echo-server/blob/master/README.md#configurable-options%E7%9A%84%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE%E7%94%9F%E6%88%90

• 若/app/laravel-echo-server.json不存在且希望通过其他方式生成，可设置环境变量LARAVEL_ECHO_SERVER_GENERATE_CONFIG为false（默认值为true）：

  bash
  $ docker run -d -p 6001:6001 -v $(pwd):/app -e "LARAVEL_ECHO_SERVER_GENERATE_CONFIG=false" oanhnn/laravel-echo-server
  

数据库配置

支持redis或sqlite数据库，通过环境变量LARAVEL_ECHO_SERVER_DB配置（默认值为redis）。

• 默认使用Redis数据库，可通过以下环境变量配置Redis参数：

  json
  "databaseConfig": {
    "redis": {
      "host": "REDIS_HOST",
      "port": "REDIS_PORT",
      "password": "REDIS_PASSWORD",
      "keyPrefix": "REDIS_PREFIX",
      "options": {
        "db": "REDIS_DB"
      }
    }
  },
  

  环境变量	默认值
  REDIS_HOST	redis
  REDIS_PORT	6379
  REDIS_PASSWORD	NULL
  REDIS_PREFIX	laravel_database_
  REDIS_DB	0

注意：这些环境变量仅在生成laravel-echo-server.json文件时使用。如需覆盖配置，可参考下一节。

• 若要使用SQLite数据库，设置环境变量LARAVEL_ECHO_SERVER_DB为sqlite，SQLite文件将存储在/app/database/目录：

  bash
  $ docker run -d -p 6001:6001 -v $(pwd):/app -e "LARAVEL_ECHO_SERVER_DB=sqlite" oanhnn/laravel-echo-server
  

通过环境变量覆盖配置

若存在环境变量（或找到/app/.env文件），以下配置项可被覆盖：

更多环境变量说明请参考https://github.com/tlaverdure/laravel-echo-server/blob/master/README.md#dotenv

贡献指南

所有代码贡献必须通过拉取请求提交，并经核心开发者审核通过后方可合并，以确保代码质量。

请 Fork 项目，创建功能分支，然后提交拉取请求。

如需帮助，可查看https://github.com/oanhnn/docker-laravel-echo-server/issues%E3%80%82

许可证

本项目基于MIT许可证发布。
版权所有 © 2020 https://github.com/oanhnn
详情请查看https://github.com/oanhnn/docker-laravel-echo-server/blob/master/LICENSE%E3%80%82