delight_im:インストール

ライブラリ本体のインストール

サンプル・プログラムでは、既にインストール済みです。

もし、新規にインストールする場合は、

1. コマンドプロンプトを起動
2. WEBアプリコードのルートに移動
3. composer require delight-im/auth
   を実行すると、
   \vendor\delight-im フォルダ以下にインストールされます。

データベースの設定

サンプル・プログラムでは、既に設定済みです。

もし、新規に設定する場合は、

1. インストールしたライブラリ本体コードの中で、
   \vendor\delight-im\auth\Databaseフォルダにある、
   PostgreSQL.sql をエディタで開きます。
   中身を全部クリップボードにコピーしておきます。
2. "C:\Program Files\PostgreSQL\17\pgAdmin 4\runtime\pgAdmin4.exe"
   を実行します。PgAdmin が起動します。
3. PgAdmin の左ペインで、
   [Databases]、[doc_list] まで行きます。
   # これで操作対象のデータベースを指定したことになります。
   ①. ツールバーの [Query Tool] ボタンを押します。
   ②. [Query] 欄に、先ほどクリップボードにコピーした内容を貼り付けます。
   ③. [Execute script] ボタンを押す。

以上で、必要なデータベースが設定されます。


サンプル・プログラムのように、ログイン操作だけできればいいのであれば、
PostgreSQL.sql の中で、
"users"、"users_2fa"、"users_audit_log"、"users_throttling"
だけあればいいので、
記載現在、他のSQLコードは省いて構いません。

更に言うと、
本来なら "users" だけあればログイン操作はできるはずなのですが、
"users_2fa"、"users_audit_log"、"users_throttling" を外すには工夫が必要で、
本体がバージョンアップした際にメンテナンスが必要になる可能性があります。

実際のWEBアプリでは、
PostgreSQL.sql 全部を入れておくのが無難だろうとは思います。

ファイル構成

次章以降の説明は、下記のファイル構成であること前提とします。
異なる場合は、パス指定部分が変わりますのでご留意ください。
★印が説明対象のファイルです。

WEBアプリのルート
  |
  +- index.html             (WEB のルート。即、main/index.php へ)
  +- composer.json          (Composer が自動生成)
  +- composer.lock          (Composer が自動生成)
  |
  +- class (クラス定義)
  |  |
  |  +- myAuth.php          (★ユーザー認証：共通設定)
  |  +- rdb.class.php       (データベース接続：説明は省略)
  |  +- login.php           (★ユーザー認証：ログイン画面)
  |  +- logout.php          (★ユーザー認証：ログアウト)
  |
  +- main (アプリ本体)
  |  |
  |  +- index.php           (★実際のWEB画面)
  |
  +- vendor (Composer関連)
     |
     +- autoload.php        (Composer が自動生成)
     |
     +- composer            (Composer が自動生成)
     |
     +- delight-im          (ユーザー認証: delight-im 本体)
     |
     +- paragonie           (セキュリティ関連のライブラリ。delight-im が導入)

また、データベースは、
サンプル・プログラムのものを、そのまま使用します。