Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 1.92 KB

INSTALL.md

File metadata and controls

88 lines (57 loc) · 1.92 KB
Raw

bpush is designed to run on a machine with LAMP.

System Requirements

  • PHP 7.0 or later
  • MySQL 5.5 or later
  • Redis 3.0 or later
  • NodeJS 5.0 or later
  • supervisord 3.0 or later
  • Java 1.8 or later
  • SSL certification and dedicated domain

PHP Extensions

Your system must be installed following php extensions for running bpush.

  • PDO
  • pdo_mysql
  • mysqlnd
  • json
  • mbstring
  • dom
  • xml
  • curl
  • intl
  • gmp
  • opcache (recommended)

Apache Configuration

  • Enable mod_rewrite module.
  • Set AllowOverride directive to "All".

Google Account

If you use VAPID ignore following process.

Google Api Console

Visit Google API Console for setting push notifications. URL: https://console.developers.google.com/

  1. If you don't have project create it.
  2. Display Dashboard page and enable Google Cloud Messaging.
  3. Display Credentials page and create API Key.

Google Cloud Platform

Visit Google Cloud Platform and confirm your Project Number displayed beside of Project ID. URL: https://console.cloud.google.com/

AWS

If you use VAPID ignore following process.

  1. Create AWS Account.
  2. Create an user who can use AWS SNS by AWS IAM(Identity and Access Management).
  3. Visit AWS SNS(Simple Notification Service) page and create an Application for GCM. And please preserve an ARN.

Installation

  1. Create config.php

Change a file name from 'config.php.template' to 'config.php' and edit it.

  1. Run init.sh
./scripts/init.sh
  1. Create database tables.

Execute DDLs located in schema/*.sql on your database to create tables.

  1. cron

Configure a cron for running these two files.

  • scripts/send_scheduled_notification.php (recommend to execute every minute)
  • scripts/watch_rss_feed.php (recommend to execute by 5 minutes)
  1. Setting a background process.

scripts/notifier.php is background worker that is run by PHP client mode. Please set up a process monitoring tool to run this program as a daemon.