Deployment

MongoDB

OpenVJ requires MongoDB 3.0 or above and you should enable the WiredTiger storage engine.

See Upgrade MongoDB to 3.0 for upgrading steps.

OS X

Recommmended configuration file /usr/local/etc/mongod.conf for Homebrew:

storage:
  dbPath: /usr/local/var/mongodb   # for other OS, modify this line
  directoryPerDB: true
  engine: wiredTiger
  journal:
    enabled: true

systemLog:
  destination: file
  path: /usr/local/var/log/mongodb/mongo.log  # for other OS, modify this line
  logAppend: true

net:
  bindIp: 127.0.0.1

###Ubuntu

sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10
echo "deb http://repo.mongodb.org/apt/ubuntu "$(lsb_release -sc)"/mongodb-org/3.0 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.0.list
sudo apt-get update
sudo apt-get install mongodb-org

Elastic Search

OpenVJ uses Elastic Search to provide searching feature.

OS X

Install elastic search (1.4.0+)
```
brew install elasticsearch
```
How to install older version: http://effectif.com/mac-os-x/installing-specific-version-of-homebrew-formula

Elastic Search book: http://es.xiaoleilu.com/010_Intro/00_README.html
Install maven:
```
brew install maven
```

Build ik plugin with maven

cd /tmp
wget https://github.com/medcl/elasticsearch-analysis-ik/archive/master.zip
unzip master.zip
cd elasticsearch-analysis-ik-master
mvn package

Copy files & enable plugin index

cd /tmp/elasticsearch-analysis-ik-master
mkdir /usr/local/var/lib/elasticsearch/plugins/analysis-ik
cp target/releases/elasticsearch-analysis-ik-1.2.9.zip /usr/local/var/lib/elasticsearch/plugins/analysis-ik/
cp -R config/ik /usr/local/opt/elasticsearch/config/ # 复制字典
cd /usr/local/var/lib/elasticsearch/plugins/analysis-ik
unzip elasticsearch-analysis-ik-1.2.9.zip
rm elasticsearch-analysis-ik-1.2.9.zip

Append /usr/local/opt/elasticsearch/config/elasticsearch.yml:

index:
  analysis:
    analyzer:
      ik:
          alias: [ik_analyzer]
          type: org.elasticsearch.index.analysis.IkAnalyzerProvider
      ik_max_word:
          type: ik
          use_smart: false
      ik_smart:
          type: ik
          use_smart: true
index.analysis.analyzer.default.type: ik

reload elastic search

launchctl unload ~/Library/LaunchAgents/homebrew.mxcl.elasticsearch.plist
launchctl load ~/Library/LaunchAgents/homebrew.mxcl.elasticsearch.plist

test

# 创建索引
curl -XPUT http://localhost:9200/index

# 创建 mapping
curl -XPOST http://localhost:9200/index/fulltext/_mapping -d'
{
    "fulltext": {
        "_all": {
            "analyzer": "ik"
        },
        "properties": {
            "content": {
                "type" : "string",
                "boost" : 8.0,
                "term_vector" : "with_positions_offsets",
                "analyzer" : "ik",
                "include_in_all" : true
            }
        }
    }
}'

# 测试分词
curl 'http://localhost:9200/index/_analyze?analyzer=ik&pretty=true' -d '
{
"text":"世界你好"
}'

Ubuntu

Install elastic search (1.4.0+)

wget -qO - https://packages.elasticsearch.org/GPG-KEY-elasticsearch | sudo apt-key add -
echo "deb http://packages.elasticsearch.org/elasticsearch/1.5/debian stable main" | sudo tee -a /etc/apt/sources.list
sudo apt-get update && sudo apt-get install elasticsearch
sudo update-rc.d elasticsearch defaults 95 10

How to install older version: http://effectif.com/mac-os-x/installing-specific-version-of-homebrew-formula

Elastic Search book: http://es.xiaoleilu.com/010_Intro/00_README.html

Install maven:
```
sudo apt-get install maven
```

Build ik plugin with maven

cd /tmp
wget https://github.com/medcl/elasticsearch-analysis-ik/archive/master.zip
unzip master.zip
cd elasticsearch-analysis-ik-master
mvn package

Copy files & enable plugin index

cd /tmp/elasticsearch-analysis-ik-master
sudo mkdir /usr/share/elasticsearch/plugins/analysis-ik
sudo cp target/releases/elasticsearch-analysis-ik-1.2.9.zip /usr/share/elasticsearch/plugins/analysis-ik/
sudo cp -R config/ik /etc/elasticsearch/ # 复制字典
cd /usr/share/elasticsearch/plugins/analysis-ik
unzip elasticsearch-analysis-ik-1.2.9.zip
rm elasticsearch-analysis-ik-1.2.9.zip

Append /etc/elasticsearch/elasticsearch.yml:

index:
  analysis:
    analyzer:
      ik:
          alias: [ik_analyzer]
          type: org.elasticsearch.index.analysis.IkAnalyzerProvider
      ik_max_word:
          type: ik
          use_smart: false
      ik_smart:
          type: ik
          use_smart: true
index.analysis.analyzer.default.type: ik

reload elastic search
```
sudo service elasticsearch restart
```

test

# 创建索引
curl -XPUT http://localhost:9200/index

# 创建 mapping
curl -XPOST http://localhost:9200/index/fulltext/_mapping -d'
{
    "fulltext": {
        "_all": {
            "analyzer": "ik"
        },
        "properties": {
            "content": {
                "type" : "string",
                "boost" : 8.0,
                "term_vector" : "with_positions_offsets",
                "analyzer" : "ik",
                "include_in_all" : true
            }
        }
    }
}'

# 测试分词
curl 'http://localhost:9200/index/_analyze?analyzer=ik&pretty=true' -d '
{
"text":"世界你好"
}'

PHP

Configure and install PHP 5.6+ if your system doesn't have one.

OS X (Homebrew):

brew install curl --with-openssl
brew install php56 --with-homebrew-curl
brew install php56-mongo php56-redis

Linux (install from source):

tar xf php.5.6.x.tar.xz
cd php-5.6.x
./configure --enable-fpm --enable-mbstring --with-openssl --with-curl
make -j8
sudo make install -j8
sudo pecl install redis mongo

Ubuntu

sudo apt-get update && sudo apt-get install python-software-properties
sudo add-apt-repository ppa:ondrej/php5-5.6
sudo apt-get install php5
sudo pecl install redis mongo

Be sure that you load the extensions in php.ini

extension=redis.so
extension=mongo.so

Install composer components.

OpenVJ uses composer to manage PHP dependencies. You need to install composer first before executing the following command.
```
composer install
```
Set default timezone in php.ini.
```
[Date]
date.timezone = Asia/Shanghai
```

Grant write permission

chmod -R 777 app/cache
chmod -R 777 app/logs

Configuration and system initialization

Generate default config file from template
```
# cd openvj
php tools/console.php config:init
```
Then modify app/config/config.yml to config the system.
Generate communication certificate
```
php tools/console.php cert:generate
```
Import some pre-defined variables into the database
```
php tools/console.php db:init
```
Create database index
```
php tools/console.php db:index:rebuild
```

Front-end

You need to run build scripts to build the front-end file from source. OpenVJ uses bower, npm and gulp to manage front-end dependencies and build dist files.

See install bower and install gulp for installing instructions.

# cd openvj
cd web
npm install
bower install
gulp shared:ext
gulp shared:lib
gulp shared:ui
gulp shared:core
gulp page:scripts

Background Service

OpenVJ separated several tasks from PHP backend to enhance user experience and improve performance.

Background service is written in ECMAScript 6, run on node.js >= 0.12 or io.js with equivalent version.

Install node.js >= 0.12.
Install grunt if you don't have one.

Clone the project

git clone https://github.com/vijos/openvj-background
cd openvj-background

Install dependencies
```
npm install
```
Configure

Copy config.yml.default to config.yml and set the peoperty value to your openvj web directory.
Build background service
```
grunt
```
Run
```
npm start
```
Notice: As a service, you may need no-hup or other similiar utilities to keep it running in the background.

Web Server Configuration

Apache

Enable mod_rewrite:

LoadModule rewrite_module libexec/apache2/mod_rewrite.so

Ubuntu

sudo a2enmod rewrite
sudo service apache2 restart

Sample configuration for HTTP server running on 80 port:

<VirtualHost *:80>
    DocumentRoot /home/to/project/openvj/web
    ServerName openvj.org
    ServerAlias www.openvj.org static.openvj.org

    <Directory "/home/to/project/openvj/web">
        <IfModule mod_rewrite.c>
            RewriteEngine On
            RewriteCond %{REQUEST_FILENAME} !-f
            RewriteRule ^(.*)$ app.php [L]
        </IfModule>
    </Directory>
</VirtualHost>

Nginx

Sample configuration for HTTP server running on 80 port:

server {
    listen 80 default;
    server_name openvj.org www.openvj.org static.openvj.org;

    root /home/to/project/openvj/web;
    
    location / {
        if (!-f $request_filename) {
            rewrite . /app.php last;
        }
    }

    error_page 404 /;

    location ~ \.php$ {
        fastcgi_pass  localhost:9000;
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
        include       fastcgi_params;
    }

    location ~ ^(.*)(/)(\..+)(.*)$ {
        deny all;
    }
}

Performance Note

use unix socket for php-fpm:

In nginx:

# With php5-cgi alone:
fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
# With php5-fpm: fastcgi_pass
# unix:/var/run/php5-fpm.sock;

In php-fpm:

listen = /var/run/php-fpm/php-fpm.sock

enable gzip for all responses:

In nginx:

gzip on;
gzip_buffers 16 64k;
gzip_http_version 1.1;
gzip_comp_level 9;
gzip_types text/plain application/x-javascript text/css application/json application/xml text/javascript;

Memorandum

Before each production deployment:

clear route cache in app/cache/route.cache

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

deploy.md

deploy.md

Deployment

MongoDB

OS X

Elastic Search

OS X

Ubuntu

PHP

Configuration and system initialization

Front-end

Background Service

Web Server Configuration

Apache

Nginx

Performance Note

Memorandum

Files

deploy.md

Latest commit

History

deploy.md

File metadata and controls

Deployment

MongoDB

OS X

Elastic Search

OS X

Ubuntu

PHP

Configuration and system initialization

Front-end

Background Service

Web Server Configuration

Apache

Nginx

Performance Note

Memorandum