forked from mataki/skip
-
Notifications
You must be signed in to change notification settings - Fork 1
/
README.txt
208 lines (167 loc) · 11.5 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
================================================================================
= SKIP version 1.8.4 http://www.openskip.org/ =
================================================================================
SKIPのダウンロードありがとうございます。
SKIPは、コミュニケーションをベースにした情報共有を実現するアプリケーションです。
オープンソースとして、"GPL ver.3"を採用しています。
このREADME.txtでは、SKIPを稼動させるまでの必要最低限の手順を記載しています。
この手順に従い稼動させた環境は、あくまで試用を目的としたものになります。
SKIPの利用方法については、以下のアドレスより参照ください。
SKIPポータルサイト = http://help.skipaas.jp/
ユーザのみなさんと編集するWikiはこちらです！
http://wiki.github.com/openskip/skip/
以下のドキュメントよりもWikiの内容が適切な場合もあります。
よりよいドキュメントにするために是非ご協力お願いします。
================================================================================
* SKIP 動作環境
================================================================================
SKIPを動かすにあたり以下の環境で検証を行っています。
（動作を保証するものではありません。また、下記環境以外でも動作する可能性はあります）
- OS : Linux (kernel 2.6系)
- DB : MySQL 5.0系
- Ruby : 1.8.6, 1.8.7
- Rails : 2.3.5
================================================================================
* SKIP バージョンアップ（version 1.8.3 -> version 1.8.4）
================================================================================
下記内容に従い旧バージョンから新バージョンにバージョンアップすることで、
SKIPを動かすことができます。
1. 設定ファイルの準備・編集（initial_settings.yml, database.yml, common_menus.yml）
--------------------------------------------------------------------------------
$ cp config/initial_settings.yml.sample config/initial_settings.yml
$ cp config/database.yml.sample config/database.yml
$ cp config/common_menus.yml.sample config/common_menus.yml
（config/initial_settings.yml, config/database.yml, config/common_menus.ymlを適切に編集してください）
2. キャッシュファイルの削除）
--------------------------------------------------------------------------------
$ rm public/javascripts/jquery.all.js
$ rm public/javascripts/skip_embedded.js
$ rm public/stylesheets/skip.style.css
================================================================================
* SKIP セットアップ（新規構築）
================================================================================
下記内容に従いセットアップすることで、SKIPを動かすことができます。
前提条件は以下のようになります。
- Ruby(1.8.6 or 1.8.7), RubyGems(1.3.5以上), MySQL(5.0系)がインストール済み。
- 公式ページもしくはgithubから最新版SKIPをダウンロード済み。
1. gemsのインストール
--------------------------------------------------------------------------------
$ sudo gem sources -a http://gems.github.com/
$ sudo gem sources -a http://rubygems.org/
$ sudo gem install rails --version 2.3.5
$ sudo gem install openskip-skip_embedded --version 0.9.19
$ sudo gem install will_paginate --version 2.3.12
$ sudo gem install fastercsv --version 1.5.1
$ sudo gem install json --version 1.2.0
$ sudo gem install mysql maedana-ar_mailer ruby-openid
$ sudo gem install gettext_rails --version 2.0.4
$ sudo gem install gettext_activerecord --version 2.0.4
$ sudo gem install locale_rails --version 2.0.4
$ sudo gem install feed-normalizer --version 1.5.2
$ sudo gem install searchlogic --version 2.4.7
$ sudo gem install nokogiri --version 1.4.1
$ sudo gem install sanitize --version 1.2.0
$ sudo gem install diff-lcs --version 1.1.2
$ sudo gem install httpclient --version 2.1.5.2
2. SKIPのファイル解凍（tarファイルをダウンロードした場合のみ）
--------------------------------------------------------------------------------
$ tar xvzf openskip-skip-xxxxxxx.tar.gz
3. 設定ファイルの準備・編集（initial_settings.yml, database.yml, common_menus.yml）
--------------------------------------------------------------------------------
$ cp config/initial_settings.yml.sample config/initial_settings.yml
$ cp config/database.yml.sample config/database.yml
$ cp config/common_menus.yml.sample config/common_menus.yml
（config/initial_settings.yml, config/database.yml, config/common_menus.ymlを適切に編集してください）
4. データベースの作成（mysqlが起動済みであること）
--------------------------------------------------------------------------------
$ RAILS_ENV=production rake db:create
$ RAILS_ENV=production rake db:migrate
5. 初期データの登録
--------------------------------------------------------------------------------
$ RAILS_ENV=production rake skip:load_default_data
6. 初期管理者ユーザ登録URLの生成
--------------------------------------------------------------------------------
$ RAILS_ENV=production ruby lib/create_new_admin_url.rb --code
7. ar_sendmailの起動（メール機能を利用する場合のみ必要）
--------------------------------------------------------------------------------
$ RAILS_ENV=production ar_sendmail -d
ar_sendmailの設定など、詳細については以下のリンク先を参考にしてください。
http://github.com/maedana/ar_mailer/raw/master/README.rdoc
8. サーバ起動
--------------------------------------------------------------------------------
$ ruby ./script/server -p [initial_settings.ymlで指定したSKIP起動ポート] -e production
9. 初期管理者ユーザの作成＆利用開始
--------------------------------------------------------------------------------
7. で表示されたURLにブラウザでアクセスして、最初の運営者となるユーザを登録してください。
================================================================================
* SKIPのユーザ追加
================================================================================
SKIPを起動した直後は利用可能ユーザが存在していません。
管理画面から、利用可能ユーザの追加を行う必要があります。
管理画面には、[SKIPセットアップの9.]で作成した初期管理者ユーザでログインするとアクセスできます。
（上部メニューの[システムの管理]をクリック）
1. 運営者でログインする（はじめての場合セットアップ時に作成したユーザが運営者です）
--------------------------------------------------------------------------------
2. 利用可能ユーザの登録
--------------------------------------------------------------------------------
>> 一人ずつ登録する場合
- システムの管理 -> データ管理 -> ユーザ -> 新規ユーザの作成 から ユーザを作成する
>> CSVで一括登録する場合
- システムの管理 -> データ管理 -> ユーザ -> ユーザのCSVアップロード から アップロードする
3. 利用開始のためのURLを利用可能ユーザに通知する
--------------------------------------------------------------------------------
- システムの管理 -> データ管理 -> ユーザ にアクセスする
- 一覧のステータス列の[利用開始待ちにする]というリンクをクリックする
- 一覧のステータス列ので[利用開始待ち]の右側にある[確認]というリンクを右クリックしURLをコピーする
- コピーしたサインアップのためのURLをユーザに連絡する
- ※詳しくはSKIP利用マニュアルを参照して下さい。
================================================================================
* バッチ一覧
================================================================================
SKIPでは、以下のバッチ処理を行っています。必要に応じてcron等へ登録してください。
- batch_make_popular_bookmarks.rb ・・・人気のブックマーク集計
- batch_make_site_counts.rb ・・・SKIP統計情報
- batch_make_user_readings.rb ・・・新着通知情報の更新
- batch_cleanup_tables.rb ・・・DB内の不要データ削除
- batch_make_ranking.rb ・・・ランキング集計
- batch_check_user_readings.rb ・・・新着通知情報のうち古いデータを削除
- batch_send_mails.rb ・・・メール送信
- batch_send_cleaning_notification.rb ・・・ユーザのクリーニング通知
- batch_make_cache.rb ・・・全文検索用キャッシュ生成
- batch_delete_cache.rb ・・・全文検索用キャッシュの不要データ削除
- batch_close_questions.rb ・・・質問掲載の強制クローズ
================================================================================
* ユニットテスト
================================================================================
SKIPでは、ユニットテストにRspecを利用しています。
利用するには、以下を実行してRspecのインストールを行なってください。
1. gemsのインストール
--------------------------------------------------------------------------------
$ sudo gem install rspec
$ sudo gem install rspec-rails
2. (未インストールならば)hyperestraierのruby用ライブラリのインストール
--------------------------------------------------------------------------------
$ wget http://hyperestraier.sourceforge.net/hyperestraier-1.4.13.tar.gz
$ tar zxvf hyperestraier-1.4.13.tar.gz
$ sudo cp hyperestraier-1.4.13/rubypure/estraierpure.rb /path_to_ruby_home/lib/ruby/site_ruby/1.8
3. データベースの作成（mysqlが起動済みであること）
--------------------------------------------------------------------------------
$ RAILS_ENV=test rake db:create
$ RAILS_ENV=test rake db:migrate
4. rspecの実行
--------------------------------------------------------------------------------
$ rake spec
このコマンドを発行するとユニットテストが実行されます。
================================================================================
* 謝辞
================================================================================
SKIPのダウンロードありがとうございます。
改善要望や不具合を発見したなどありましたら、SKIPユーザグループにてご報告ください。
SKIPユーザグループ = https://www.youroom.in/r/openskip
* ライセンス ・・・ GPL ver.3 (http://www.gnu.org/licenses/gpl.html)
* アイコン提供・・・ famfamfam.com (http://www.famfamfam.com/lab/icons/silk/)
================================================================================
= お問い合わせは・・・ [email protected] =
================================================================================
= SKIP http://www.openskip.org/ =
================================================================================