thinkingreed-inc / F-RevoCRM

日本で最も利用されているオープンソースCRM
https://f-revocrm.jp
Other
46 stars 41 forks source link
crm docker mysql php

F-RevoCRM 7.4

F-RevoCRM は日本企業に合わせた形で開発された高機能なCRMです。 あらゆる顧客接点を管理するために、キャンペーン・リード管理から顧客・商談管理、販売管理、サポート管理・プロジェクト管理まで幅広い機能を持ち合わせています。

公式サイト https://f-revocrm.jp

推奨環境の変更について

2021年3月26日にアナウンス( https://github.com/thinkingreed-inc/F-RevoCRM/commit/c33e4e55b7fc83462a60d83fb84215d07796758f )していたとおり、2022年4月1日を持ちましてIE11環境を非推奨と致しました。
以降はGoogle Chromeの最新版、またはChromium Edgeの最新版をご利用ください。

ライセンス

Vtiger Public License 1.2

サーバ推奨要件

※PHPの下位バージョンでも概ね動作しますが、未検証のため推奨から除外しています。

F-RevoCRMへのアクセスについて

本アプリケーションはWebアプリケーションとなりますので、URLへ直接アクセスしてください。
またリファラーチェックを行っておりますので、もしSharePointなどの社内イントラにリンクを設置する場合は、rel=noreferrer属性を追加してください。

<a href="https://example.com/{CRM_DIR}/index.php">F-RevoCRM</a>​​​​​​
↓
<a href="https://example.com/{CRM_DIR}/index.php" rel="noreferrer">F-RevoCRM</a>​​​​​​

PCの推奨環境

モバイルデバイスの推奨環境

インストール方法(概要)

以下、F-RevoCRMのインストール方法になります。

configファイルを独自に設定する場合

configファイルはconfig.inc.phpとして、インストール後に生成されます。
このファイルは、config.template.phpをベースに、インストーラーが自動生成するファイルとなりますので、もし独自に設定する必要がある場合はconfig.template.phpconfig.inc.phpにリネームし、利用してください。

前提条件

データベース名などを「frevocrm」としてインストールすることを前提に記載します。

1. Apache, PHP, MySQLのインストール

事前にそれぞれをインストールしておいてください。

*注意点1

MySQLのSTRICT_TRANS_TABLESを無効にしてください。

# 下記手順は設定例

vi /etc/my.cnf

# 以下の行を変更
[変更前]
sql_mode=NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES

[変更後]
sql_mode=NO_ENGINE_SUBSTITUTION

# mysqlを再起動
service mysqld restart

MySQL8.0以降の場合は、認証モードの変更が必要です。

vi /etc/my.cnf

# [mysqld]のセクションの中に以下の1行を追加
default-authentication-plugin=mysql_native_password

# mysqlを再起動
service mysqld restart

*注意点2

php.iniにて以下の設定が必要です。

date.timezone = "Asia/Tokyo"
max_input_vars = 100000
post_max_size = 32M
upload_max_filesize = 32M
max_execution_time = 60

*注意点3

「.htaccess」によるアクセス制限を実施しています。 「.htacesss」が有効になるようにAllowOverride Allに設定してください。

2. F-RevoCRMのZIPファイルを解凍、設置

ApacheのDocumentRoot以下に解凍したディレクトリ毎、あるいはファイルを置いて下さい。 ここでは仮に/var/www/frevocrmに設置したものをとして進めます。

3. composer installの実行

F-RevoCRMはPHPの各種ライブラリをcomposer経由でインストールする必要があります。

cd /var/www/html/frevocrm
composer install

4. 初期設定

3.で設置したF-RevoCRMのURLを開きます。

画面に従って初期設定を完了させてください。

バージョンアップ方法

F-RevoCRM 6.5 を F-RevoCRM 7.4 にバージョンアップする手順になります。

前提条件

1. バックアップの取得

F-RevoCRMのデータベース、ファイルを全てバックアップを取得します。

2. プログラムファイルの置き換え

  1. F-RevoCRMのディレクトリ全体を別名に置き換えます。
    # コマンド例
    mv frevocrm frevocrm.20201001
  2. F-RevoCRM 7.4 インストール直後のファイルをもともとのF-RevoCRMのディレクトリとしてコピーします。
    # コマンド例
    cp -r frevocrm73 frevocrm
  3. F-RevoCRMの設定ファイル(config., .properties, *tabdata.php)をコピーします。
    # コマンド例
    cp frevocrm.20201001/config.* frevocrm/
    cp frevocrm.20201001/*.properties frevocrm/
    cp frevocrm.20201001/*tabdata.php frevocrm/

    4.F-RevoCRMのドキュメントファイルをコピーします。

    # コマンド例
    cp -r frevocrm.20201001/storage/* frevocrm/storage/

3. マイグレーションツールの実行

タグとしてv7.4.xが追加されるまで、Migrationは実行されません。
最新のバージョンで実行したい場合は、vtigerversion.phpのファイルを編集し、次のバージョンを指定してから以下のマイグレーション用のURLを実行してください。

  1. アクセスすると自動でマイグレーションが実行されます。

  2. 動作確認 F-RevoCRMのログインや業務に関わる動作を確認してください。

  3. 作業ディレクトリの削除

    # コマンド例
    rm -r frevocrm.20170118

開発環境の構築

Dockerで構築する為、docker/README.mdを参照してください。

初期設定

Gitコマンドを使い以下の設定を行ってください。
下記コマンドにより、不要な変更点が表示されなくなります。

git update-index --assume-unchanged parent_tabdata.php
git update-index --assume-unchanged tabdata.php
git update-index --assume-unchanged user_privileges/user_privileges_1.php

xdebug

xdebug3がインストール済みです。 docker-compose.yml の以下の部分を修正してください

# Xdebugの設定を有効にしたい場合は、mode=debug に変更してください
# XDEBUG_CONFIG: "mode=off client_host=host.docker.internal client_port=9003 start_with_request=yes"
XDEBUG_CONFIG: "mode=debug client_host=host.docker.internal client_port=9003 start_with_request=yes"

WSL2での利用

WSL2を利用の場合は、以下のように実行してください。

cp docker-compose.override.yml.exmple docker-compose.override.yml
cp .env.example .env

その後、.envの中にWSL2のIPアドレスを入力してください。

hostname -I
# 172.26.76.74
vim .env
# DOCKER_HOST_IP=172.26.76.74

VSCodeでの設定

vscodeをご利用の場合は、xdebugのエクステンションをインストール後、以下のように .vscode/launch.jsonを修正してください。

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "F-RevoCRM XDebug:9003",
      "type": "php",
      "request": "launch",
      "port": 9003, 
      "pathMappings": {
        "/var/www/html": "${workspaceRoot}"
      }
    }
  ]
}

更新履歴

更新履歴を参照してください。