tomk79/rencon

0.0.1 2020-02-06 15:47 UTC

Requires

• php: >=5.4.0
• ext-pdo: *

Requires (Dev)

• phpunit/phpunit: ^4.1.0
• symfony/finder: >=2.4.0
• tomk79/request: ^1.0

MIT

• Tomoya Koyanagi

README

rencon は、手軽にサッと使えるブラウザベースの簡易サーバー管理ツールです。

PHPスクリプト 1ファイルの構成で、使いたいときにすぐに使え、使い終わったら容易に削除してしまえます。 GUIベースのウェブアプリケーションなので、普段コマンド操作に慣れていない方でも操作できます。

提供される機能は次の通りです。

• ファイルとフォルダ
• データベース操作

インストール手順 - Install

dist ディレクトリにある rencon.phpを、 お使いのウェブサーバーのドキュメントルート以下の任意の場所に配置して、 ウェブブラウザからアクセスします。

例: 手動で設置する場合

• リリースの一覧ページ から、最新のバージョンの rencon.php をダウンロードする。
• テキストエディタで開き、適宜設定を書き換える。(任意)
• FTPツールなどを使い、お使いのお使いのウェブサーバーのドキュメントルート以下の任意の場所にアップロードする。
• ウェブブラウザからアクセスする。

例: curl コマンドを使う場合

$ cd /path/to/your/htdocs/(foo)/(bar);
$ curl https://github.com/tomk79/rencon/releases/download/0.0.1/rencon.php -L -o rencon.php;

テキストエディタで開き、適宜設定を書き換えます。(任意)

$ vi rencon.php

設定する - Configuration

rencon.php をテキストエディタで開くと、先頭付近には、

// =-=-=-=-=-=-=-=-=-=-=-= Configuration START =-=-=-=-=-=-=-=-=-=-=-=
$conf = new stdClass();

で始まる設定ゾーンが記述されています。

$conf の値を書き換えて、rencon の機能を制御することができます。

ログインユーザー設定

rencon の初期画面は、ログイン画面から始まります。 $conf->users に 登録されたユーザーが、ログインを許可されます。 ユーザーIDを キー に、sha1ハッシュ化されたパスワード文字列を 値 に持つ連想配列で設定してください。 ユーザーは、複数登録できます。

$conf->users = array(
	"admin" => sha1("admin"),
);

ユーザーを登録しない場合は、ログインなしで使用できます。 そうしたい場合は、$conf->users を null に設定してください。

$conf->users = null;

無効にする機能

$conf->disabled = array(
	'databases', // データベース操作を無効化
	'files', // ファイルとフォルダ操作を無効化
	'phpinfo', // phpinfo() の閲覧を無効化
);

データベース接続情報設定

データベースに接続するために必要な情報を設定します。 連想配列で複数の接続先を設定できます。

$conf->databases = array(
  "main_db" => array(
    "dsn" => "sqlite:./db/database.sqlite", // PDOの第1引数に渡される値
    "driver" => "sqlite", // DBドライバ名 (`dsn` が設定される場合は不要)
    "host" => "127.0.0.1", // 接続先ホスト名 (`dsn` が設定される場合は不要)
    "port" => 3306, // 接続先ポート番号 (`dsn` が設定される場合は不要)
    "database" => "my_database_name", // 接続先データベース名 (`dsn` が設定される場合は不要)
    "username" => "user", // ログインユーザー名
    "password" => "passwd", // ログインパスワード
    "options" => array(), // PDOオプション
  ),
);

ファイル一覧のルートディレクトリ

$conf->files_path_root = '/';

表示させないパスのリスト

$conf->files_paths_invisible = array();

編集できなくするパスのリスト

$conf->files_paths_readonly = array(
	'/*',
);

システム要件 - System Requirement

• PHP 5.4+ が動作するウェブサーバー
• mbstring が有効なこと。
• データベース操作を利用する場合
  • PDO が有効なこと。
  • 使用するDBMSに対応するPDOドライバーが有効なこと。

(!) 使用上の注意

このツールは、サーバー上の、本来ブラウザから見えてはならない情報を見えるようにするものです。 第三者に悪用されると大変危険です。

• 安全が確認されている環境でのみ使用してください。
• 特に、個人情報や重要な機密情報にアクセスできるサーバーには設置しないでください。
• 使ったまま置きっぱなしにせず、 すぐに削除してください。

更新履歴 - Change log

rencon v0.0.1 (2020年2月7日)

• Initial Release.

開発者向け情報 - for Developer

ビルド - Build

$ php build/build.php

テスト - Test

$ php vendor/phpunit/phpunit/phpunit

ライセンス - License

MIT License

作者 - Author

• Tomoya Koyanagi [e-mail]
• website: https://www.pxt.jp/
• Twitter: @tomk79 https://twitter.com/tomk79/