導入方法
ここでは, 本CMSの導入方法を説明します.
すぐに使用したい方は, 項目のはじめるをご覧ください.
はじめる
サーバに ContentsPlanet フォルダを置く
[ContentsPlanet (CMS)/ダウンロード]から, ダウンロードした ContentsPlanet フォルダをサーバに置きます. ルートディレクトリでなくても問題ありません.
sshでログインしている場合は, おきたいフォルダにcd
で移動後, 以下のコマンドでダウンロード可能です.
git clone https://github.com/ContentsViewer/ContentsPlanet.git
ContentsPlanet/
にアクセスする
ContentsPlanet フォルダを配置後, すでにアクセス可能です.
以下の項目を確認してください.
- お使いのWebサーバソフトウェアは, Appacheである
- php7.xに対応している
以上を満たしていないウェブサーバには, 残念ながら本CMSは対応しておりません.
アクセスしたページにあるセットアップガイド
リンクをクリックし, ユーザ設定を行う.
セットアップガイド
リンクが見つからない場合は, URL欄からContentsPlanet/Setup
にアクセスしてください.
注意点
この項目に書かれていることを誤ると, エラーになる可能性があります.
Masterユーザは必要です
本CMSでは, 少なくともMasterユーザが必要になります(Masterといってもユーザ名まで’master’にする必要はありません).
Masterユーザとは, Home/Master
ディレクトリを所有するユーザを指します.
各ユーザは, Contents
フォルダ, Contents/Root.content
ファイルを持つ必要があります.
これらファイルとフォルダは, 各ユーザフォルダに存在しておく必要があります.
設定項目
Tipsデータ
Home/Master/Contents/Tips.content
には, ファイル管理ページに表示されるTipsのデータが記述されています. 追加したい内容を下の行に追加することができます.
Messagesデータ
Home/{UserName}/Contents/Messages.content
には, ウェブページの上部にポップアップされる訪問者に対するメッセージデータが記述されています. 追加したい内容を最下行に追加することができます. 行頭に//
を書くことで, そのメッセージは無効になります.
ファイル構成
- ContentsPlanet
- .htaccess: アクセスファイル(自動生成される)
- CollabCMS.php: システム設定ファイル
- index.php: ページ窓口
- LICENSE: ライセンス
- OutputLog.txt: ログファイル(自動生成)
- README.md: 説明ファイル
- Cache: キャッシュフォルダ
- .htaccess: アクセスファイル
- Client: クライアントサイドファイルフォルダ
- ace: エディタ
- ace-diff: ファイル差分表示/マージライブラリ
- Common: 共通フォルダ
- ContentsViewer: コンテンツ表示用ライブラリ
- FileManager: ファイル管理ライブラリ
- OutlineText: 文章構成補助ライブラリ, スタイルシート
- Space-RUN: ゲーム
- Splitter: 画面分割ライブラリ
- syntaxhighlighter: コード表記ライブラリ
- ThemeChanger: テーマ切り替え
- Frontend: フロントエンド群
- 400.php: 400ページ
- 403.php: 403ページ
- 404.php: 404ページ
- 500.php: 500ページ
- content-editor.php: コンテンツ編集ページ
- contents-viewer.php: コンテンツ表示ページ
- directory-viewer.php: ディレクトリ表示ページ
- error-page.php: 基本エラーページ
- error-page-setup.php: エラーページセットアップ
- file-manager.php: ファイル管理
- file-server.php: ファイルサーバ
- login.php: ログインページ
- logout.php: ログアウトページ
- note-viewer.php: ノート表示ページ
- plaintext.php: プレインテキスト表示ページ
- preview.php: プレビューページ
- setup.php: セットアップページ
- tag-viewer.php: タグ表示ページ
- viewer.php: ビューページ
- Home: ユーザデータ保存フォルダ
- Master: デフォルト管理ユーザー
- Contents: コンテンツファイル保存フォルダ
- Root.content: 根となるコンテンツ
- Tips.content: Tipデータコンテンツ
- Messages.content: ウェブメッセージコンテンツ
- .index: インデックス(自動生成)
- .metadata: メタデータ(自動生成)
- Contents: コンテンツファイル保存フォルダ
- Master: デフォルト管理ユーザー
- Module: サーバサイドライブラリ
- Authenticator.php: ユーザ権限管理
- BinarySearch.php: 二分探索機
- CacheManager.php: キャッシュ管理
- ContentsDatabase.php: コンテンツの保存と読み込み
- ContentsDatabaseManager.php: コンテンツデータベース全体にかかわる情報保持
- ContentsViewerUtil.php: コンテンツ表示関数群
- Debug.php: デバッグ表示ライブラリ
- Localization.php: ローカリゼーション管理ライブラリ
- OutlineText.php: 文章構成補助ライブラリ
- SearchEngine.php: 検索エンジン
- ServiceUtils.php: サービスで使用する補助関数
- Stopwatch.php: 処理速度計測ライブラリ
- Utils.php: 共通補助関数
- Service: サーバサイドサービス
- contents-database-edit-service.php: コンテンツ情報編集サービス
- contents-search-service.php: コンテンツ検索サービス
- file-management-service.php: ファイル, フォルダ管理サービス
- mail-service.php: メール送信サービス
- outlinetext-decode-service.php: OutlineText変換サービス
- related-search-service.php: 関連コンテンツ提示サービス
ユーザの追加
ユーザフォルダ作成
Home/{ユーザ名}
を作成.Home/{ユーザ名}/Contents
を作成Home/{ユーザ名}/Contents/Root.content
を作成
ユーザテーブルにユーザ追加
ContentsPlanet.php
のファイル内のUSER_TABLE
に上に書かれているほかのユーザと同じように情報を記述します.
contentsFolder
は上で作成した./{ユーザ名}/Contents
を入力します.
define('USER_TABLE', [ 'master' => [ 'hashedPassword' => '', 'digest' => '', 'contentsFolder' => './Master/Contents', 'isPublic' => true, 'enableRemoteEdit' => false, 'remoteURL' => '', ], 'ユーザ名' => [ 'hashedPassword' => '', 'digest' => '', 'contentsFolder' => 'コンテンツパス', 'isPublic' => true, 'enableRemoteEdit' => false, 'remoteURL' => '', ], ]);
パスワードと権限の設定
Frontend/setup.php
にある$username
にはmaster
を, $password
にあなたの設定したいパスワードを書きます.
初回起動時にMasterユーザの設定をしたのと同じように, パスワードとアクセス権の設定を行います.