10.11. config.php変数

一部のサイトオプションは管理エリアでは設定できません、それで config.php ファイルをサーバ上で直接更新する必要があります。このセクションでは、可能な設定と、サイトの config.php ファイルに設定を含める理由を理解します。

config.php ファイルは、サイトの /htdocs ディレクトリにあります。可能なすべての変数とそのデフォルト値を見たい場合、 /htdocs/lib/config-defaults.php に見つけることができます。 config.php ファイルに変数を置くことで、デフォルト値を上書きすることができます。

10.11.1. 設定変数分析

機能するには、構成変数を正しい構文で記述する必要があります。Maharaでは、これは次のように行われます: $cfg->variable = value;

A typical configuration variable

標準設定値

  1. $cfg->: 「設定」 を意味します。後続するものが設定変数であることを示します。
  2. variable =: ここでは、設定する変数が表示されます。一般的に、それは一つの単語で構成されているか、または単語がアンダースコアで結合されています。変数にはスペースを入れることはできません。
  3. value;: 変数が取得する値が表示されます。値は異なるものにすることができます。例えば次のようになります:
    • 「true」 または 「false」
    • テキスト
    • 数字
    • ファイルパス

注釈

Maharaのインスタンスで変数のデフォルトの動作を変更する場合は、 config-defaults.php ファイルから config.php ファイルにコピーして、コードベースを更新するときに上書きされないようにします。 config.php ファイルは、Maharaのアップデートやアップグレードによって決して変更されません。

10.11.2. developermode: 開発者モードを有効または無効にする

「$cfg->developermode = true;」または「$cfg->developermode = false;」

開発者モードを有効にすると、サイトに対して次の二つの変更が自動的に行われます:

  • debug.css は各ページに含まれます。このファイルを編集して、あなたの裁量でデバッグCSSを追加することができます。
  • MochiKitのアンパックされたバージョンが使用されます。【訳注】MochiKitはMahara 17.04以降削除されました。

注釈

developermode=trueproductionmode=false よりも強力ではありません。

10.11.3. openbadgedisplayer_source: Open Badgesディスプレイヤのソース

$cfg->openbadgedisplayer_source = '{"shortname":"url","shortname":"url"}';

「オープンバッジ」 ブロック にオープンバッジを表示するには、バッジをホストするサイトを設定する必要があります。デフォルトでは、Mozilla BackpackOpen Badge Passport を接続することができます。他のソースがある場合は、それらを許可されたソースに追加する必要があります。

10.11.4. passwordsaltmain: サイト全体のpassword saltを設定する

$cfg->passwordsaltmain = 'ここであなたの秘密の言葉を設定してください';

パスワードソルトは、 「ハッシュ」 パスワードをデータベースでより安全に使用して、ハッキングをより困難にするのに役立ちます。フレーズを使うのはよいスタートです。パスワードはすでにデータベースにプレーンテキストで表示されていません。ハッシュされています。このソルトはそれをさらにランダム化するのに役立ちます。

あなたにパスワードsaltがない場合、 「管理ホーム」 ページで警告が表示されます。

10.11.5. pathtoclam: ウィルススキャナ ClamAV へのパス

$cfg->pathtoclam = '/path/to/your/clamscan';

サーバ上でウイルス対策エンジン ClamAV を実行しており、システムレベルでウイルスをスキャンしない場合は、Maharaにファイルの場所を知らせて、アップロードされたファイルをスキャンします。セキュリティ上の理由から、サーバ上のClamAVへのパスを config.php ファイルで指定する必要があります。

「セキュリティ設定」 で設定したパスを確認することができます。

10.11.6. probationenabled: ユーザ保護観察状態を与える

$cfg->probationenabled = true; または $cfg->probationenabled = false;

同じように $cfg->probationstartingpoints = 2; を設定する必要があります

ユーザの スパムの保護観察レベル を設定して、自己登録ユーザが特にパブリックサイトに迷惑メールを投稿しないようにすることができます。これを行うには、次の二つの変数を使用します:

  • $cfg->probationenabled = true;: この設定は、ユーザが保護観察を受けることができるかどうかを決定します。
  • $cfg->probationstartingpoints = 2;: この設定では、新しく自己登録されたユーザがデフォルトごとに保持する保護観察ポイントの数を指定します。この例では、ユーザがすべての機能を利用できるようになるには、二つの保護観察ポイントが必要になります。

保護観察ポイントは、管理ユーザのアカウント設定ページ で個別に変更することができます。

保護観察を有効にすると、ページやアーティファクにコメントを残してログインしていないユーザは、URLを投稿することはできません。

10.11.7. productionmode:プロダクションモードを有効または無効にする

$cfg->productionmode = true; または $cfg->productionmode = false;

プロダクションモードが無効になっている場合は、画面上部にその旨を示すメッセージが表示されます。

Info message when site is not in prodution mode

サイトがプロダクションモードでない場合の情報メッセージ

テストサイトや開発サイトでは、多くのパラメータが適切なデフォルト値で上書きされます。現在のパラメータのリストについては、 init.php を参照してください。これらの設定には、次のものが含まれます:

  • デバッグ情報、警告メッセージ、および環境ターゲットを画面とエラーログに出力します。これにより、画面に直接表示されるエラーメッセージをすばやく確認できます。
  • 開発者モード をオンにします。
  • キャッシュを無効にします。

注釈

逆説的に、 productionmode=false は適切な開発者モードのデフォルトで多くの設定を上書きするため、テスト/開発サイトで設定を微調整する場合は、 productionmode=true を設定する必要があります。

10.11.8. remoteavatarbaseurl: リモートアバタサーバURL

$cfg->remoteavatarbaseurl = 'http://example.com/avatar/';

ユーザのプロファイル画像は、Gravatarなどのアバターサービスから取得できます。あなた自身のサービス、例えば、Libravatar を実行する場合、この構成変数を使用してMaharaを直接指すことができます。

あなたはリモートの化身を表示するかしないかを 「ユーザ設定」 で決めます。

10.11.9. renamecopies: コピーされたページおよびコレクションを改名する

$cfg->skins = true; または $cfg->skins = false;

サイト管理者は、コピーしたページやコレクションに対して 「のコピー」 を追加することができます。 $cfg->renamecopies = true の場合、新しいページとコレクションのコピーにはそのタイトルの後に 」 のコピー」 が付加されます。デフォルトの設定は $cfg->renamecopies = false; です。【訳注】デフォルトの設定の場合、コピーにはそのタイトルの後に 」 v.2」 のようなコピー回数に応じた文字列が付加されます。

10.11.10. showloginsideblock: ログインサイドブロックを表示するまたは隠す

$cfg->showloginsideblock = true; または $cfg->showloginsideblock = false;

config.php ファイルに値 $cfg->showloginsideblock = false を追加してログインフォームを非表示にすることができます。これを実行すると、管理者、またはMaharaアカウントを持つ他のユーザがサイトにログインするためのログインフォームへのリンクだけが表示されます。

Link to the login form

ログインフォームへのリンク

これは、シングルサインオンを設定し、別のサイトからMaharaに自動的にログインする場合に便利です。

デフォルトでは、値は 「true」 に設定され、ログインサイドブロックが表示されます。

10.11.11. sitethemeprefs: 任意のテーマからあなたのブラウズテーマを選択する

$cfg->sitethemeprefs = true;` または $cfg->sitethemeprefs = false;

サイト管理者が許可している場合は、 「アカウント設定」 ページの閲覧テーマとして利用可能なテーマを選択できます。その場合、あなたはあなたのインスティテューションテーマを使用することだけに制限されているか、あるいはあなたが複数のインスティテューションメンバーである場合、それらの間で選択します。

10.11.12. スキン

$cfg->skins = true; または $cfg->skins = false;

テーマを選択する以外に、ユーザが自分のポートフォリオページをパーソナライズできるようにすることができます。これはMaharaの skins スキンを介して行われます。スキンは、サイトレベル または個人によって作成することができます。インスティテューションは、ユーザに スキンの使用を許可または拒否する ことができます。

10.11.13. urlsecret: あなたが権限を与えられているときだけクーロンあるいはアップグレードを実行する

$cfg->urlsecret = 『somesecret』;`

この設定変数がなければ、誰でもあなたのサイトでcronジョブ(スケジュールされたタスク)を実行したり、アップグレードによって問題を引き起こす可能性があります。

この変数を config.php ファイルに置き、デフォルト値を上書きします。自分の秘密のフレーズ(一重引用符で囲みます)を選んで、誰がcronやアップグレードを実行することが許されているかを知る人はほとんどいません。

cronを実行したり、アップグレードを実行したりするときは、URLの最後に秘密の単語を追加する必要があります。cronとupgradeのURLは次のようになります( 「somesecret」 を自分の秘密の単語で置き換えます):

  • cron: /lib/cron.php?urlsecret=somesecret
  • upgrade: /admin/upgrade.php?urlsecret=somesecret

注釈

ファイアウォールの背後にある開発者インスタンスまたはテストサーバを使用している場合、特にそのサイトにアクセスできる唯一のユーザである場合は、毎回URLを追加したくない場合があります。あなたはこれらのサイトの config.php ファイルに $cfg->urlsecret = null; を置くことができ、秘密のフレーズを入力する必要はありません。ただし、プロダクションサイトや、多くの人がアクセス可能な他のサイトでは、これを使用しないでください。

10.11.14. usersuniquebyusername: 内部のMaharaユーザ名は、外部の認証方法を接続するときに優先される

$cfg->usersuniquebyusername = true; あるいは $cfg->usersuniquebyusername = false;

これは 実験的な機能 です。この設定をオンにすると、ユーザのSSOがどのアプリケーションから来ているかには関係なく、内部ユーザ名が一致し、リモートユーザ名が無視されるため、Maharaで同じアカウントが与えられることになります。