<commit_before>===========================
OpenPNE3.8 セットアップ手順
===========================

はじめに
========

このドキュメントは、 OpenPNE バージョン 3.8 を基にして書かれています。

OpenPNE3 は以下のようなサーバ環境で動作させることを想定しています。

Webサーバ
  Apache 
    * mod_rewrite を使用可能
PHP
  PHP5.2.3 以降
    * PHP の mbstring 拡張モジュールを使用可能
    * PHP の XML 拡張モジュールを使用可能
    * PHP の PCRE 拡張モジュールを使用可能 (UTF-8 サポート)
    * PHP の PDO 拡張モジュールを使用可能 (利用する DBMS のドライバも含む)
    * PHP の JSON 拡張モジュールを使用可能
    * PHP から GD ライブラリを使用可能 (JPEG/GIF/PNG サポート)
    * PHP の mcrypt 拡張モジュールの使用を推奨
    * PHP の APC 拡張モジュールの使用を推奨
データベースサーバ
  MySQL4.1以降（5.1 以降を推奨）
  
  PostgreSQL, SQLite は現時点で未サポート（将来的にサポート予定）

セットアップ
============

OpenPNE3 のソースコードを入手する
---------------------------------

以下の URL に記載されている情報に従って、 OpenPNE 3 のソースコードをダウンロードしてください。

http://www.openpne.jp/pne-downloads/

ファイルの設置
--------------

以下のような構造になるようにサーバ上にファイルを設置してください。

::

  ./
  +-- LICENSE
  +-- NOTICE
  +-- apps/
  +-- config/
  +-- data/
  +-- doc/
  +-- lib/
  +-- log/
  +-- plugins/
  +-- symfony
  +-- test/
  
  (ブラウザから閲覧可能)
  +-- web/  (ディレクトリ名は変更可能)
      +-- index.php
      +-- js/
      +-- mobile_frontend.php
      +-- pc_backend.php
        :

設定ファイルをコピー
--------------------

以下のようにして設定ファイルをコピーしてください。

::

  $ cd OpenPNE3
  $ cp config/ProjectConfiguration.class.php.sample config/ProjectConfiguration.class.php
  $ cp config/OpenPNE.yml.sample config/OpenPNE.yml

その後、 OpenPNE.yml の設定値を環境に合わせて変更してください。特に base_url と mail_domain はメール投稿、メール配信の際に利用されるので必ず設定をおこなってください。

インストールコマンドの実行
--------------------------

以下のコマンドを実行し、インストール作業をおこなってください。

::

  $ ./symfony openpne:install

このコマンドはデータベースを削除し、作り直します。
※但し、以上のコマンドはバンドルプラグインがダウンロード・インストールされないため、バンドルプラグインをダウンロード・インストールする場合は、以下の --internet オプションを付けてコマンドを実行してください。

::

  $ ./symfony openpne:install --internet

他のシステムとデータベースを共有する場合などで、データベース自体の削除がおこなわれては都合が悪い場合、以下のオプションを付けてコマンドを実行してください。

::

  $ ./symfony openpne:install --non-recreate-db

--non-recreate-db オプションを付けて実行する場合、 OpenPNE はこれから作成しようとしているテーブル名と同名のテーブルを外部キーなどを考慮して適切な順序で削除しようとします。
他システムのテーブルが予期せず削除されてしまったり、 OpenPNE の想定の外で外部キー制約などによりテーブルの削除に失敗したりといった危険を避けるため、OpenPNE.yml の設定で OpenPNEが使用するテーブルにプレフィックスを付けておくことを強く推奨します。

※このプレフィックスは同一 DB に対して複数の OpenPNE をインストールするためのものではなく、DB を共有している他システムとテーブル名がバッティングするのを避けるためのものであることに注意してください。

::

  table_prefix: "op_" 

::

  $ ./symfony openpne:install --internet

openpne:install コマンドを実行すると、はじめに、以下の事項の入力を求められます。
<commit_msg>fixed openpne setup guide document (fixes #3009)<commit_after>===========================
OpenPNE3.8 セットアップ手順
===========================

はじめに
========

このドキュメントは、 OpenPNE バージョン 3.8 を基にして書かれています。

OpenPNE3 は以下のようなサーバ環境で動作させることを想定しています。

Webサーバ
  Apache 
    * mod_rewrite を使用可能
PHP
  PHP5.2.3 以降
    * PHP の mbstring 拡張モジュールを使用可能
    * PHP の XML 拡張モジュールを使用可能
    * PHP の PCRE 拡張モジュールを使用可能 (UTF-8 サポート)
    * PHP の PDO 拡張モジュールを使用可能 (利用する DBMS のドライバも含む)
    * PHP の JSON 拡張モジュールを使用可能
    * PHP から GD ライブラリを使用可能 (JPEG/GIF/PNG サポート)
    * PHP の mcrypt 拡張モジュールの使用を推奨
    * PHP の APC 拡張モジュールの使用を推奨
データベースサーバ
  MySQL4.1以降（5.1 以降を推奨）
  
  PostgreSQL, SQLite は現時点で未サポート（将来的にサポート予定）

セットアップ
============

OpenPNE3 のソースコードを入手する
---------------------------------

以下の URL に記載されている情報に従って、 OpenPNE 3 のソースコードをダウンロードしてください。

http://www.openpne.jp/pne-downloads/

ファイルの設置
--------------

以下のような構造になるようにサーバ上にファイルを設置してください。

::

  ./
  +-- LICENSE
  +-- NOTICE
  +-- apps/
  +-- config/
  +-- data/
  +-- doc/
  +-- lib/
  +-- log/
  +-- plugins/
  +-- symfony
  +-- test/
  
  (ブラウザから閲覧可能)
  +-- web/  (ディレクトリ名は変更可能)
      +-- index.php
      +-- js/
      +-- mobile_frontend.php
      +-- pc_backend.php
        :

設定ファイルをコピー
--------------------

以下のようにして設定ファイルをコピーしてください。

::

  $ cd OpenPNE3
  $ cp config/ProjectConfiguration.class.php.sample config/ProjectConfiguration.class.php
  $ cp config/OpenPNE.yml.sample config/OpenPNE.yml

その後、 OpenPNE.yml の設定値を環境に合わせて変更してください。特に base_url と mail_domain はメール投稿、メール配信の際に利用されるので必ず設定をおこなってください。

インストールコマンドの実行
--------------------------

以下のコマンドを実行し、インストール作業をおこなってください。

::

  $ ./symfony openpne:install

このコマンドはデータベースを削除し、作り直します。
※但し、以上のコマンドはバンドルプラグインがダウンロード・インストールされないため、バンドルプラグインをダウンロード・インストールする場合は、以下の --internet オプションを付けてコマンドを実行してください。

::

  $ ./symfony openpne:install --internet

他のシステムとデータベースを共有する場合などで、データベース自体の削除がおこなわれては都合が悪い場合、以下のオプションを付けてコマンドを実行してください。

::

  $ ./symfony openpne:install --non-recreate-db

--non-recreate-db オプションを付けて実行する場合、 OpenPNE はこれから作成しようとしているテーブル名と同名のテーブルを外部キーなどを考慮して適切な順序で削除しようとします。
他システムのテーブルが予期せず削除されてしまったり、 OpenPNE の想定の外で外部キー制約などによりテーブルの削除に失敗したりといった危険を避けるため、OpenPNE.yml の設定で OpenPNEが使用するテーブルにプレフィックスを付けておくことを強く推奨します。

※このプレフィックスは同一 DB に対して複数の OpenPNE をインストールするためのものではなく、DB を共有している他システムとテーブル名がバッティングするのを避けるためのものであることに注意してください。

::

  table_prefix: "op_" 

openpne:install コマンドを実行すると、はじめに、以下の事項の入力を求められます。

{'fraction_non_alphanumeric': 0.15689981096408318, 'fraction_numerical': 0.007561436672967864, 'mean_word_length': 3.352833638025594, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '644313', 'n_tokens_mistral': 3248, 'n_tokens_neox': 3029, 'n_words': 297}