Open NAMAE clientの使い方

概要

本ツールは、GNU/LinuxとWindowsの双方で動作可能な、「お名前.com DDNSクライアント」の非公式オープンソース実装です。
アプリ本体はcronから実行可能なようCUIとしつつも、設定画面はGUIとすることで公式実装からの切り替えが容易となるよう配慮しました。

このほか、実行時間をランダムに遅延させて接続先サーバの負荷を分散させる機能や、複数ドメインのDNS情報を一括で更新する機能を搭載しています。

システム要件

本ツールは、WindowsまたはGNU/Linuxのデスクトップ環境で動作するGUIアプリケーションです。

本ツールを使用するためには、あらかじめ、使用するPCまたはGUIサーバに最新のPython 3実行環境をインストールしておく必要があります。

WindowsにPython 3をインストールする際、カスタム構成でインストールする場合は、「tcl/tk」を構成に含めるようにしてください。
また、標準構成でインストールする場合でも、インストール画面の「Add Python 3.* to PATH」はチェックが入った状態でインストールを実行してください。

GNU/Linuxの多くのディストリビューションでは標準でpython3パッケージがインストールされていますが、本ツールを使用するためにはこれに加えてpython3-tkinter(ディストリビューションによってはpython3-tk)パッケージが必要となります。

インストール

本ツールは、OSを問わず、ダウンロードした圧縮ファイルを任意のフォルダに展開することでそのまま使用することができます。
DDNS更新に使用する各種設定やDDNS更新処理の実行ログなどは本ツールのフォルダ内に保存されるため、アンインストールは本ツールをフォルダごと削除するだけで完了します。

なお、GNU/Linuxの場合は、付属のファイル open_namae_gui.desktop を、ご利用の環境に合わせてテキストエディタで編集してから、 /home/(ユーザー名)/.local/share/applications にコピーし、最後に以下のコマンドを実行することで、アプリケーションの一覧から本ツールのGUIを起動することができるようになります。 update-desktop-database ~/.local/share/applications ※.local は隠しフォルダのため、隠しフォルダを表示しない設定ではファイルマネージャに表示されません。

DDNSサーバの設定

本ツールは、お名前.comの公式DDNSクライアントと同様、お名前.comの管理画面で行うドメインの設定はデフォルト値のままでDDNS機能を使用することができます。
サブドメインを使用する場合でも、公式DDNSクライアントの場合と同様、事前にそのサブドメインのAレコードを作成していれば問題なくDDNS機能の使用が可能です。

GUIで行う設定

GUIの起動

Windowsの場合は、 open_namae_gui.bat をダブルクリックすれば本ツールのGUIが起動します。
GNU/Linuxの場合は、 open_namae_gui.py をダブルクリックするか、同ファイルを端末エミュレータからPython3コマンドで実行してください。

GUIではDDNS情報更新の各種設定やDDNS情報更新ログの確認ができます。

基本設定

本ツールを使用してDNS情報を更新するためには、GUIで以下の項目を設定する必要があります。

お名前ID

数字の並びで表される「お名前.com」のユーザーIDです。

パスワード

「お名前.com」の管理画面にログインする際に使用するパスワードです。

グローバルIP確認URL

本ツールを実行している端末のグローバルIPアドレスを取得するためにアクセスする外部URLを指定します。
使用可能なURLは動作確認済みURLのリストをご確認ください。

ドメイン

DNS情報を更新するドメインを1行に1つずつ入力します。
サブドメインを使用する場合は、サブドメインと本ドメインをピリオドではなくセミコロン(「;」)で区切ってください。

高度な設定

以下の設定項目は、メニューバーから「高度な設定」を開くことで変更することが可能です。

DDNSサーバ接続設定

DNS情報更新用エンドポイントのホストとポート番号を指定します。基本的にデフォルト値から変更する必要はありません。

実行とログ

DNS情報の更新処理はGUIから直接実行することもできます。
DNSの更新を実行してエラーが発生した場合は、メニューから実行ログを表示することでエラーの詳細を確認可能です。

また、GUIの上部に表示されるDNS情報更新結果は1分おきに自動更新されるため、cronによるCUIクライアント実行が正常に行われているかどうかをリアルタイムで把握することができます。

CUIクライアント

CUIクライアントを実行する

CUI環境、及び、cronによる本ツールの定期実行では、以下のコマンドでCUIクライアントを使用してDNS情報を更新します。

python3 /path/to/open_namae_client/cui_client.py ※ファイルパスは環境に合わせて変更してください。

コマンドラインオプション

CUIクライアントではコマンドライン引数として以下のオプションが使用可能です。

-i : 負荷分散のための待ち時間を無視して即座に処理を実行します。cronによる定期実行ではこのオプションを使用しないでください。
-f : 端末のグローバルIPアドレスが変わっていない場合でも処理を実行します。このオプションがない場合でも、前回の処理から20時間以上経過している場合や、前回の処理でエラーが発生している場合は、自動的に処理が実行されます。
-s : 標準出力に実行結果を出力しません。

cronによる定期実行

CUIクライアントはcronにより定期実行することが可能です。
例えば、毎時3分から43分まで20分間隔でCUIクライアント実行する場合は、以下のようにcrontabへ設定します。

3-43/20 * * * * python3 /path/to/open_namae_client/cui_client.py -s ※負荷分散のため、毎時0分や15分などのきりのよい時間に実行する設定は避けてください。
※グローバルIPアドレス確認用サーバの負荷を軽減するため、5分未満の間隔で実行することはご遠慮ください。
※オプション"-f"を指定しない場合、グローバルIPアドレスに変更がなければ、前回のDNS情報の更新から20時間以上経過していない限りDNS情報を更新しません。
※ファイルパスは環境に合わせて変更してください。

ライセンス

本ツール本体、及び、この利用説明を含む各付属ファイルは無権利創作宣言に準拠して著作権放棄されています。
これらのファイルの二次利用について、著作権による制約はありません。

お問い合わせ

本ツールについてのお問い合わせはMidari Createまでお願いします。