Project

General

Profile

Enhancement(機能追加・改善) #3009

インストールドキュメントの更新

Added by Shouta Kashiwagi about 8 years ago. Updated about 8 years ago.

Status:
Fixed(完了)
Priority:
Normal(通常)
Assignee:
Target version:
Start date:
2012-04-20
Due date:
% Done:

100%


Description

概要

#2968 の修正によって, ./symfony openpne:install だけではバンドルプラグインがダウンロード&インストールされなくなった為,その旨を記すとともに,
./symfony openpne:install --internet とすることによりバンドルプラグインのダウンロード&インストールができるようになったこと,
及び ./symfony openpne:fast-install ( #2622 )が追加されたことも記す.


Related issues

Related to OpenPNE 3 - Enhancement(機能追加・改善) #3024: OpenPNE2からのアップグレード手順書を削除する Fixed(完了) 2012-04-23
Related to OpenPNE 3 - Enhancement(機能追加・改善) #3025: バージョンアップ(3.8.0向け)の動作確認を行う Fixed(完了) 2012-04-23
Related to OpenPNE 3 - Enhancement(機能追加・改善) #3027: バージョンアップ手順書の更新 Fixed(完了) 2012-04-24

Associated revisions

Revision 4a4a3695 (diff)
Added by Fumie Toyooka about 8 years ago

(fixes #3009)change description of install commands in setup guide.

Revision 5bd956b3 (diff)
Added by Fumie Toyooka about 8 years ago

(fixes #3009)change description of install commands in setup guide in English and Japanese.

Revision cca02fc7
Added by Shouta Kashiwagi about 8 years ago

Merge pull request #36 from fumicos/t3009

(fixes #3009)change description of install commands in setup guide.

Revision 424160ff (diff)
Added by Shouta Kashiwagi about 8 years ago

fixed openpne setup guide document (fixes #3009)

History

#1 Updated by Yuma Sakata about 8 years ago

  • Assignee changed from Shouta Kashiwagi to Fumie Toyooka

#2 Updated by Fumie Toyooka about 8 years ago

  • Status changed from New(新規) to Accepted(着手)

下書き

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

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

::

  $ ./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 コマンドを実行すると、はじめに、以下の事項の入力を求められます。

* 使用する DBMS (mysql, pgsql, sqlite から選択。ただし mysql 以外は未サポート)
* データベース名
* データベースへの接続用ユーザ名
* データベースへの接続用パスワード(未入力可)
* データベースサーバのホスト名(localhost など)
* データベースサーバのポート番号(未入力可)
* (DBMS に MySQL を選択し、サーバホスト名に localhost を指定した場合)使用するソケットへのパス(未入力可)

以上の事項について入力をおこなうと、インストール作業が自動でおこなわれます。

また、これらの入力事項をコマンドの引数としてデータベースの設定値を指定してインストールすることも可能です。
以下は使用例ですので、設定値は適宜変更してください。

::

 $ ./symfony openpne:fast-install --dbms=mysql --dbuser=username --dbpassword=password --dbhost=localhost\
 --dbport=10 --dbname=databasename --dbsock=/tmp/mysql.sock

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

#3 Updated by Yuma Sakata about 8 years ago

日本語版だけでなく英語版も対応お願いします。

#4 Updated by Yuya Watanabe about 8 years ago

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

--no-recrete-db 誤字
ちょっと一文が横に長い.

#5 Updated by Shouta Kashiwagi about 8 years ago

#note-2 について, ./symfony openpne:fast-install の説明で --internet オプションの説明も加えたほうが良いかと思います.
(#note-4を除き) パラメーターの名称等はあっていますので特に問題無いと思います.

#6 Updated by Fumie Toyooka about 8 years ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

https://github.com/openpne/OpenPNE3/pull/36
とりあえず、日本語のみプルリクエストしました。

日本語のレビューをお願いします。
問題無ければ、この文章を元に、英語版を作成します。

一応ステータスをレビュー待ちにします。

#7 Updated by Yuya Watanabe about 8 years ago

  • Status changed from Pending Review(レビュー待ち) to Rejected(差し戻し)

改行が多すぎると感じました.
また文章部分での次の行と同一の行であることを示す意味でのバックスラッシュはこのドキュメントでは必要ないと思います.
コマンドに関する部分ではバックスラッシュによる改行を適宜利用するのもありですが,一部しか適用されていないため不十分です.

#8 Updated by Fumie Toyooka about 8 years ago

諒解です、確かに調子にのって改行しすぎていました。
修正します。

// ブランチ間違えて切ってた気がするけど、大丈夫かなメモ。

#9 Updated by Fumie Toyooka about 8 years ago

  • Status changed from Rejected(差し戻し) to Accepted(着手)
  • % Done changed from 50 to 0

#10 Updated by Yuya Watanabe about 8 years ago

ついでにですが,下記 3.6 と記載されている部分は 3.8 に書き換えておいたほうがよさそうです.

===========================
OpenPNE3.6 セットアップ手順
===========================

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

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

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

#11 Updated by Fumie Toyooka about 8 years ago

諒解ですー

#12 Updated by Fumie Toyooka about 8 years ago

  • Status changed from Accepted(着手) to Pending Review(レビュー待ち)
  • % Done changed from 0 to 50

https://github.com/openpne/OpenPNE3/pull/36
日本語も英語もプルリクエストしました。

#13 Updated by Fumie Toyooka about 8 years ago

更新履歴 4a4a369580a4e6c67615f64bd956da1ae3d611df で適用されました。

#14 Updated by Fumie Toyooka about 8 years ago

更新履歴 5bd956b384c171d523bd77f8a3ee9559e66abe5b で適用されました。

#15 Updated by Shouta Kashiwagi about 8 years ago

更新履歴 cca02fc76a084b8907b3fe4be179167b8dbcb186 で適用されました。

#16 Updated by Mutsumi Imamura about 8 years ago

  • Status changed from Pending Review(レビュー待ち) to Fixed(完了)
  • % Done changed from 50 to 100

確認しました。OKです。

#17 Updated by Mutsumi Imamura about 8 years ago

  • Status changed from Fixed(完了) to Rejected(差し戻し)
  • % Done changed from 100 to 50

すみません。クローズ後に気が付きました。

https://github.com/openpne/OpenPNE3/blob/stable-3.8.x/doc/ja/OpenPNE3_Setup_Guide.txt#L114 の箇所が英語版と異なっています。
不要な記述だとおもいますので、削除をお願いします。

112 ::
113 
114   $ ./symfony openpne:install --internet
115 

#18 Updated by Shouta Kashiwagi about 8 years ago

  • Status changed from Rejected(差し戻し) to Pending Review(レビュー待ち)

更新履歴 424160ff2b8ba1ca1fcf304f00de42a2527d50e7 で適用されました。

#19 Updated by Yuya Watanabe about 8 years ago

  • Status changed from Pending Review(レビュー待ち) to Pending Testing(テスト待ち)
  • % Done changed from 50 to 70

#20 Updated by Yuma Sakata about 8 years ago

  • Status changed from Pending Testing(テスト待ち) to Fixed(完了)
  • % Done changed from 70 to 100

テストOKです。

Also available in: Atom PDF