導入前に確認できる公開ガイド
PiyoCMSは、既存サイトに必要な更新機能だけを追加できる軽量CMSです。
このページでは、動作環境・導入の流れ・設置イメージなど、導入前に確認しておきたい内容をまとめています。
目次
1. PiyoCMSとは
PiyoCMSは、サイト全体をCMS化するのではなく、お知らせや記事など「更新したい部分だけ」を管理できる軽量CMSです。
既存サイトを活かしたまま、後から更新機能を追加したいケースに向いています。
2. このような場合に向いています
お知らせだけ更新したい
サイト全体の作り直しは不要で、ニュースや新着情報だけを更新したい場合に向いています。
既存サイトを活かしたい
すでに完成しているHTMLサイトへ、後から管理機能を追加したい場合にも使えます。
必要な機能だけで十分
サイト全体を大きく作り替えず、更新に必要な機能だけを追加したい案件に向いています。
3. 動作環境
必須要件
- PHP 7.4以上
data/と PiyoCMS本体側のuploads/に書き込み権限があること
推奨環境
- Apache(.htaccess が利用できる環境)
- Rewriteを利用する場合は mod_rewrite が有効であること
補足
- Rewriteを使わない場合でも利用できる構成があります
- nginx ではURL書き換え設定などを手動で行う必要があります
- 共有サーバーでも、PHPと書き込み権限が利用できれば動作する場合があります
- ※
- 購入前に一番確認したいのは、「PHPが動くか」と「書き込み権限を設定できるか」です。
4. 導入の流れ
-
ファイルをアップロードする
まずはCMS本体と、記事を表示する公開ページ側をサーバーへ配置します。 -
初期設定を確認する
CMS本体を置いた場所と、記事を表示する場所を確認し、必要に応じて設定を調整します。 -
管理画面へアクセスする
管理画面が正しく表示されれば、記事の作成と公開確認を進められます。 -
記事を作成して公開ページで確認する
記事保存、画像アップロード、公開ページ表示まで確認できれば基本導入は完了です。
5. 設置イメージ
PiyoCMSでは、「CMS本体」と「公開ページ」は別の場所に置いて使います。
この2つを分けて考えることが、導入時に最も大切です。
/piyocms/ ← CMS本体
/news/ ← 公開ページ
たとえば /piyocms/ に管理画面やAPIがあり、/news/ に記事一覧ページ・詳細ページを置く構成です。
6. 最低限の設定
導入時に特に重要なのは、site_path と public_path を混同しないことです。
site_path
PiyoCMS本体を設置したURLパスです。
例:ルート直下なら /、/piyocms/ に置くなら /piyocms/
ここが間違っていると、管理画面のCSSやJavaScript、APIの参照先が正しく動作しません。
public_path
記事を表示する公開ページ側のURLパスです。
例:/news/、/blog/、ルート直下で使う場合は /
この設定を基準に、一覧ページ・詳細ページのURLが決まります。
画像やPDFは、PiyoCMS本体側の uploads/ から配信されます。必要に応じて media_url を設定できます。
サーバー上の物理パスそのものを入力する項目ではありません。
購入後には、より詳しいインストール手順と設定例を同梱しています。
7. 表示方法
テンプレート方式
既存HTMLに専用クラス・API URL・プレースホルダーを記述し、テンプレート用JavaScriptを読み込むことで表示できます。
<ul
class="js-piyo-content"
data-piyo-api="/piyocms/api/posts.php"
data-piyo-status="published"
hidden>
{piyo-list limit="5" category="cat_a,cat_b" order="desc"}
<li>
<a href="{piyo-href}">
<time datetime="{piyo-datetime}">{piyo-time}</time>
<span>{piyo-title}</span>
</a>
</li>
{/piyo-list}
</ul>
- ※
- 実際の利用時は、テンプレート用JavaScriptの読み込みも必要です
- ※
- 上記は
site_pathが/piyocms/の場合の例です
API方式
JavaScriptでAPIを直接利用して自由に描画する方法です。デザインや構造を柔軟に制御できます。
<div
data-piyo-mode="list"
data-piyo-api="/piyocms/api/posts.php"
data-piyo-status="published"
data-piyo-limit="5"
data-piyo-category="cat_a,cat_b"
data-piyo-order="desc">
</div>
- ※
- 上記は
site_pathが/piyocms/の場合の例です - ※
- 公開ページが
.htmlの場合は、data-piyo-apiを明示して組み込む運用が安全です - ※
- API方式では、同梱の piyo-api-example.js を使うか、APIレスポンスを取得して描画するJavaScriptを用意します
8. よくある質問
難しいですか?
基本的な導入は、サーバーへファイルを配置し、設置パスと公開パスを確認できれば進められます。
ただし、PHPが利用できること、書き込み権限を設定できることは事前に確認が必要です。
既存サイトに使えますか?
はい。既存のHTMLサイトへ後から追加する用途に向いています。
公開ページはPHPでなくても使えますか?
はい。HTMLでも利用できます。その場合は、data-piyo-api など必要な指定を明示して組み込む運用が安全です。
カテゴリごとに記事を表示できますか?
はい。特定カテゴリのみ、または複数カテゴリをまとめて表示できます。
Rewriteを使うとURLはどうなりますか?
Rewrite無効時は ?slug=hello のような形式です。
Rewrite有効時は public_path に応じて /news/hello/ や /hello/ のような形式になります。