インストールおよびアドミニストレーション・ガイド¶
イントロダクション¶
このインストールおよびアドミニストレーション・ガイドでは、FIWARE RELEASE 6用のFIWARE CKAN拡張機能(FIWARE CKAN extensions)について説明します。CANAN自体のインストールの詳細については、CKAN Installation Guide を参照してください。
バグ、誤植、含まれるべきであると思われるものを含め、この文書のいかなるフィードバックも非常に歓迎されます。このGEiのカタログページ に表示される” Contact Person(担当者)”の電子メールにそれらを送信するか、または、GitHub Issues に問題点を書き込んでください。
現在のバージョンのソフトウェアは、CKAN versions 2.6 および 2.7 でテストされています。
OAuth2¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性のある OAuth2 CKAN extension v0.3.8-fiware のインストールについて説明します。
インストール¶
OAuth2 extension は GitHub で利用可能で、次のコマンドでダウンロードできます :
$ git clone https://github.com/conwetlab/ckanext-oauth2
$ cd ckanext-oauth2
$ git checkout v0.3.8-fiware
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています。
拡張機能がダウンロードされ、virtualenv がアクティブ化されたら、次のコマンドで拡張機能をインストールできます :
$ python setup.py install
または、開発用の拡張機能をインストールする場合は、次のようにします :
$ python setup.py develop
コンフィグレーション¶
CKANでOAuth2 extensionを有効にするには、.ini ファイルの ckan.plugins 設定(通常は /etc/ckan/default/production.ini)に含める必要があります。
ckan.plugins = oauth2 <other-plugins>
さらに、この拡張機能では、動作を設定し、選択したIdMとの統合を設定するために、一連の設定を.iniファイルに含める必要があります。特に :
## OAuth2 configuration
ckan.oauth2.logout_url = /user/logged_out
ckan.oauth2.register_url = https://YOUR_OAUTH_SERVICE/users/sign_up
ckan.oauth2.reset_url = https://YOUR_OAUTH_SERVICE/users/password/new
ckan.oauth2.edit_url = https://YOUR_OAUTH_SERVICE/settings
ckan.oauth2.authorization_endpoint = https://YOUR_OAUTH_SERVICE/oauth2/authorize
ckan.oauth2.token_endpoint = https://YOUR_OAUTH_SERVICE/oauth2/token
ckan.oauth2.profile_api_url = https://YOUR_OAUTH_SERVICE/user
ckan.oauth2.client_id = CLIENT_ID
ckan.oauth2.client_secret = CLIENT_SECRET
ckan.oauth2.scope = all_info
ckan.oauth2.rememberer_name = auth_tkt
ckan.oauth2.profile_api_user_field = id
ckan.oauth2.profile_api_fullname_field = displayName
ckan.oauth2.profile_api_mail_field = email
ckan.oauth2.authorization_header = Bearer
次の意味で :
- logout_url: ユーザをログアウトするために CKAN で使用される URL
- register_url: ユーザを登録するための選択された IDM の URL
- reset_url: ユーザのパスワードをリセットするための選択された IDM の URL
- edit_url: ユーザ情報を更新するために選択された IDM の URL
- authorization_endpoint: OAuth2 プロセスで認証コードを取得するための、選択された IDM の URL
- token_endpoint: OAuth2 プロセスでアクセストークンを取得するための、選択された IDM の URL
- profile_api_url: ユーザ情報を取得するために選択された IDM の URL
- client_id: CKN インスタンスに IDM によって与えられたクライアント ID
- client_secret: CKAN インスタンスに選択された IDM によって与えられたクライアント・シークレット
- profile_api_user_field: IDM が提供するユーザ情報オブジェクト内のユーザ ID を含むフィールドの名前
- profile_api_fullname_field: IDM によって提供されるユーザ情報オブジェクト内のユーザ表示名を含むフィールドの名前
- profile_api_mail_field: IDM が提供するユーザ情報オブジェクト内のユーザ電子メールを含むフィールドの名前
- authorization_header: 認証のためにアクセストークンを使用して CKAN APIs にアクセスするために使用されるヘッダ
この拡張機能は、デフォルトでは HTTPS にデプロイされた CKAN で使用されるように設計されているため、セキュリティで保護されていない CKAN インスタンスで使用するとエラーになることに注意してください。この拡張機能をセキュリティで保護されていないインスタンスで使用するには、OAUTHLIB_INSECURE_TRANSPORT 環境変数を true に設定する必要があります :
$ export OAUTHLIB_INSECURE_TRANSPORT=True
あるいは、CKAN が Apache にデプロイされている場合は、/etc/apache2/envvars
最後に、IDM で CKAN を登録するために使用する必要があるコールバック URL は次のとおりです :
https://YOUR_CKAN_INSTANCE/oauth2/callback
Private Datasets¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性のある Private Datasets CKAN extension v0.3 のインストールについて説明します。
インストール¶
Private Datasets extension は GitHub で利用可能で、次のコマンドでダウンロードできます :
$ git clone https://github.com/conwetlab/ckanext-privatedatasets
$ cd ckanext-privatedatasets
$ git checkout v0.3
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています
拡張機能がダウンロードされ、virtualenv がアクティブ化されたら、次のコマンドで拡張機能をインストールできます :
$ python setup.py install
または、開発用の拡張機能をインストールする場合は、以下を実行します :
$ python setup.py develop
コンフィグレーション¶
Private Datasets extension を有効にするには、.ini ファイルの ckan.plugins 設定で、privatedatasets を含むことが必要です :
ckan.plugins = privatedatasets <other-plugins>
また、拡張機能の動作をカスタマイズするために、いくつかの設定を行うことができます。特に :
ckan.privatedatasets.parser = ckanext.privatedatasets.parsers.fiware:FiWareNotificationParser
ckan.privatedatasets.show_acquire_url_on_create = True
ckan.privatedatasets.show_acquire_url_on_edit = True
次の意味で :
- parser: ユーザーアクセス許可を解析し、データセットに取り消すために使用されるクラス
- show_acquire_url_on_create: データセット作成フォームで取得 URL (アクセス許可を取得できる URL) を表示するかどうか
- show_acquire_url_on_edit: データセット更新フォームに取得 URL を表示するかどうか
NGSI View¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性のある NGSI View CKAN extension ngsiv2 のインストールについて説明します
インストール¶
NGSI View extension は GitHub で利用でき、以下のコマンドでダウンロードできます :
$ git clone https://github.com/conwetlab/ckanext-ngsiview
$ cd ckanext-ngsiview
$ git checkout ngsiv2
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています
拡張機能がダウンロードされ、virtualenv が有効になったら、プラグインは次のコマンドでインストールできます:
$ python setup.py install
または、開発のためにプラグインをインストールする場合は、以下を実行します :
$ python setup.py develop
コンフィグレーション¶
NGSI View extension を有効にするには、.ini ファイルの ckan.plugins と ckan.views.default_views 設定の中に ngsiview を含めることが必要です :
ckan.plugins = ngsiview <other-plugins>
ckan.views.default_views = ngsiview <other-views>
BAE Publisher¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性のある BAE Publisher CKAN extension v0.4 のインストールについて説明します。
要件¶
- Business API Ecosystem v5.4.0 以上
- OAuth2 CKAN extension がインストールされている
- Private Datasets extension がインストールされている
インストール¶
BAE Publisher extension は GitHub で利用でき、以下のコマンドでダウンロードできます :
$ git clone https://github.com/FIWARE-TMForum/ckanext-baepublisher
$ cd ckanext-baepublisher
$ git checkout v0.4
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています
拡張機能がダウンロードされ、virtualenv がアクティブ化されたら、次のコマンドで拡張機能をインストールできます :
$ python setup.py install
または、開発用の拡張機能をインストールする場合は、以下を実行します :
$ python setup.py develop
コンフィグレーション¶
BAE publisher extension を有効にするには、.ini ファイルの ckan.plugins の設定の中で baepublisher を含めることが必要です。さらに、ckan.storepublisher.store_url で使用する BAE インスタンスの URL を設定する必要があります :
ckan.plugins = baepublisher <other-plugins>
ckan.baepublisher.store_url = https://YOUR_BAE_INSTANCE/
WireCloud View¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性のある WireCloud View CKAN extension v1.0.0 のインストールについて説明します。
要件¶
- WireCloud v1.0 以上
- OAuth2 CKAN extension がインストールされている
インストール¶
WireCloud View の拡張機能は GitHub で利用でき、次のコマンドでダウンロードできます :
$ git clone https://github.com/conwetlab/ckanext-wirecloud_view
$ cd ckanext-wirecloud_view
$ git checkout 1.0.0
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています
拡張機能がダウンロードされ、virtualenv がアクティブ化されたら、次のコマンドで拡張機能をインストールできます :
$ python setup.py install
または、開発用の拡張機能をインストールする場合は、以下を実行します :
$ python setup.py develop
コンフィグレーション¶
WireCloud View extension を有効にするには、.ini ファイルの ckan.plugins の設定の中に wirecloud_view を含めることが必要です:
ckan.plugins = wirecloud_view <other-plugins>
また、使用する WireCloud インスタンスに関連するいくつかの設定を行う必要があります。特に :
ckan.wirecloud_view.url = https://YOUR_WIRECLOUD_INSTANCE
ckan.wirecloud_view.editor_dashboard = wirecloud/ckan-editor
次の意味で :
- url: WireCloud サーバの URL
- editor_dashboard: 基本的なダッシュボード作成のウィザードとして使用される WireCloud インスタンスのダッシュボード
Data Requests¶
このガイドでは、FIWARE release 6 の一部として提供されるソフトウェアと互換性がある Data Requests CKAN extension v1.0.0 のインストールについて説明します。
インストール¶
Data Requests extension は GitHub で利用でき、以下のコマンドでダウンロードできます :
$ git clone https://github.com/conwetlab/ckanext-datarequests
$ cd ckanext-datarequests
$ git checkout v1.0.0
拡張機能を CKAN にインストールするには、次のように CKAN 仮想環境を有効にする必要があります :
$ . /usr/lib/ckan/default/bin/activate
Note
上記のコマンドは、CKAN virtualenv が /usr/lib/ckan/default にあると仮定しています
拡張機能がダウンロードされ、virtualenv がアクティブ化されたら、次のコマンドで拡張機能をインストールできます :
$ python setup.py install
または、開発用の拡張機能をインストールする場合は、以下を実行します :
$ python setup.py develop
コンフィグレーション¶
Data Requests extension を有効にするには、.ini ファイルの ckan.plugins の設定の中に datarequests を含めることが必要です :
ckan.plugins = datarequests <other-plugins>
さらに、いくつかの設定を含めることによって、拡張機能の動作をカスタマイズすることも可能です。特に :
ckan.datarequests.comments = true
ckan.datarequests.show_datarequests_badge = true
次の意味で :
- comments: コメントシステムが有効かどうか
- show_datarequests_badge: メニューにバッジ内のデータリクエスト数を表示するかどうか