serh/docker-laravel-echo-server repository overview

⁠oanhnn/docker-laravel-echo-server

Repository of oanhnn/laravel-echo-server Docker image.
Alpine based Laravel Echo Server⁠ image.

⁠Tags

⁠Version tags

Image Tag	Badges
v1.0.0
v2.0.0
2.1.0

⁠Shared tags

• latest - 2.1.0

⁠Features

• Base from node:10-alpine image
• Install laravel-echo-server

⁠Requirement

• Docker Engine 1.13+

⁠Usage

⁠Run laravel-echo-server

Run laravel-echo-server by command

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

⁠Auto generate config file

• If /app/laravel-echo-server.json is exists, it will be loaded

• If /app/laravel-echo-server.json isn't exists, it will be generated from default configs with laravel-echo-server⁠.

• If /app/laravel-echo-server.json isn't exists and you want it will be generated by another process, please set environment variable GENERATE_CONFIG to false (default true).

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

  Copy

⁠Configure database

Using database be configured by environment variable LARAVEL_ECHO_SERVER_DB (default is redis).

• By default, Redis database will be used. You can set Redis config by environment variables:

  "databaseConfig": {
    "redis": {
      "host": "REDIS_HOST",
      "port": "REDIS_PORT",
      "keyPrefix": "REDIS_KEY_PREFIX",
      "options": {
        "db": "REDIS_DB_BACKEND"
      }
    },
    "sqlite": {}
  },
  

  Copy

  Environment variable	Default value
  REDIS_HOST	redis
  REDIS_PORT	6379
  REDIS_KEY_PREFIX	laravel_database_
  REDIS_DB_BACKEND	0

• You can use SQLite database by set environment variable LARAVEL_ECHO_SERVER_DB to sqlite. The SQLite file will store in /app/database/

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

  Copy

⁠Override config by environment variables

If some environment variables are existed (allow load /app/.env file is found), the following options can be overridden:

See more about laravel-echo-server.json in here⁠

⁠Run laravel-echo-server sub-commands

$ 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

⁠Contributing

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send a pull request.

If you would like to help take a look at the list of issues⁠.

⁠License

This project is released under the MIT License.
Copyright © 2018 Oanh Nguyen⁠
Please see License File⁠ for more information.