Funkwhaleのソースを表示

[[Category:メディアサーバー]]
[[Category:音楽]]
[[Category:ウェブアプリケーション]]
[[en:Funkwhale]]
{{Related articles start}}
{{Related|Django}}
{{Related|Apache HTTP Server}}
{{Related|Nginx}}
{{Related|OpenSSL}}
{{Related|Certbot}}
{{Related|Redis}}
{{Related|PostgreSQL}}
{{Related articles end}}
[https://docs.funkwhale.audio/index.html メインドキュメントページ]: から引用 
:[https://funkwhale.audio/ Funkwhale] is a self-hosted, modern, free and open-source music server, heavily inspired by Grooveshark.

インスタンスは ActivityPub プロトコルで連携できます。

== インストール ==

Funkwhale にはリバースプロキシ ([https://docs.funkwhale.audio/installation/index.html]) が必要です。
したがって、[[nginx]] または [[Apache HTTP Server]] をインストールする必要があります。

また、設定された [[PostgreSQL]] データベースと [[Redis]] キャッシュサーバーも必要です。
詳細については、[[Funkwhale#設定]] およびそれぞれのページを参照してください。

=== AUR からのインストール ===

{{AUR|funkwhale}} パッケージを [[インストール]] して下さい。

{{warning|このインストールでは Python virtualenv を使用しないため、すべての Python 依存関係は主に AUR からシステム全体にインストールされます。パッケージのバージョンが上流の要件と異なる場合があり、問題が発生する可能性があります。}}

=== 手動インストール ===

[https://docs.funkwhale.audio/installation/debian.html] にある Arch のインストール手順に従ってください。
これにより、すべてのコンポーネントが {{ic|/srv/funkwhale}} にインストールされます。

=== Docker のインストール ===

[https://docs.funkwhale.audio/installation/docker.html] にある Docker のインストール手順に従ってください。

== 設定 ==

以下のセクションでは、Funkwhale が AUR からインストールされたことを前提としています。
手動インストールの場合は、フォルダーを適切に変更する必要があります。

また、ローカルネットワーク上で Funkwhale を使用していることも前提としています。
外部からアクセスできるようにする方法については、公式 [https://docs.funkwhale.audio/index.html ドキュメント] を参照してください。
特に [[Certbot]] を使用する証明書の場合。

=== ホスト設定 ===

{{ic|/etc/hosts}} ファイルが正しく設定されていることを確認してください。
Funkwhale サーバーは、{{ic|127.0.0.1}} でエイリアス {{ic|funkwhale.local}} で実行されていますが、これは変更できます。

{{ic|/etc/hosts}} ファイルは次のようになります。

{{bc|#<ip-address>   <hostname.domain.org>   <hostname>
127.0.0.1       localhost
::1             localhost
127.0.0.1       funkwhale.local}}

=== nginx の設定 ===

Nginx 構成ファイルのアップストリーム テンプレートは、{{ic|/etc/webapps/funkwhale/nginx.template}} で提供されます。
ただし、このファイルには、{{ic|env}} ファイルの値で置き換える必要がある変数が含まれています
(このファイルの作成方法についてはセクション [[Funkwhale#初期化|初期化]] を参照してください):

 $ set -a && source /srv/funkwhale/config/env && set +a
 $ envsubst "`env | awk -F = '{printf \" $%s\", $$1}'`" \
    < /etc/webapps/funkwhale/nginx.conf \
    > /etc/nginx/sites-available/funkwhale.conf

証明書へのパスもそれに応じて変更する必要があります。

次に、サイトを有効にします:

 $ ln -s /etc/nginx/sites-available/funkwhale.conf /etc/nginx/sites-enabled/

そして、{{ic|nginx.service}} を [[起動]] します。

=== Apache の設定 ===

{{note|[[Redis]]、[[PostgreSQL]]、および Apache [[TLS]] サポートを使用して実行するように [[Apache HTTP Server]] を設定する必要があります。}}

テンプレートの Apache 設定ファイルは、{{ic|/etc/webapps/funkwhale/apache-funkwhale.conf}} で提供されます。Funkwhale インスタンスが {{ic|https://funkwhale.local}} でアクセスできるように設定されます。

フォルダー名は、インストールに合わせて変更する必要があります。どの行を変更する必要があるかについての詳細は、[https://docs.funkwhale.audio/installation/index.html#reverse-proxy-setup] で説明されています。

テンプレートを Apache 設定フォルダーにコピーし、

 $ cp /etc/webapps/funkwhale/apache-funkwhale.conf /etc/httpd/conf/extra/funkwhale.conf

次に、[[Apache HTTP Server]] 設定ファイルを編集し、以下を追加します。

{{hc|# /etc/httpd/conf/httpd.conf|
Include conf/extra/funkwhale.conf
}}

変更を適用するには、[[systemd#ユニットを使う|systemd]] を使用して {{ic|httpd.service}} (Apache) を再起動する必要があります。

=== PostgreSQL の設定 ===

ここでは、公式ドキュメントに従います: [https://docs.funkwhale.audio/installation/external_dependency.html]

{{ic|postgres}} ユーザーを使用して [[PostgreSQL]] コマンドラインに接続し、{{ic|funkwhale}} ユーザーとデータベースを作成します。

{{hc|$ sudo -u postgres psql|2=
CREATE DATABASE "funkwhale"
 WITH ENCODING 'utf8';
CREATE USER funkwhale;
GRANT ALL PRIVILEGES ON DATABASE funkwhale TO funkwhale;
\c funkwhale;
CREATE EXTENSION "unaccent";
CREATE EXTENSION "citext";
}}

最後の 3 行は、{{ic|unaccent}} および {{ic|citext}} 拡張機能をロードします。
これらは funkwhale が動作するために必要です ({{ic|citext}} バージョン 0.20 以降)

== 初期化 ==

=== Funkwhale ユーザー ===

Funkwhale は、{{ic|funkwhale}} ユーザーとして実行する必要があります。これは、AUR パッケージによって自動的に作成されます。
手動インストールに従った場合は、次のように作成します。

 # useradd -r -d /srv/funkwhale -m funkwhale -c "Funkwhale music server -s /sbin/nologin"

Funkwhale のデータフォルダーを {{ic|/srv/funkwhale}} に作成します。
{{ic|funkwhale}} ユーザーが所有:

 # mkdir /srv/funkwhale
 # chown funkwhale:funkwhale /srv/funkwhale

{{ic|funkwhale}} ユーザーとして次のコマンドを実行します。

API ファイルとストレージ用のサブフォルダーを作成します:

 [funkwhale]$ cd /srv/funkwhale
 [funkwhale]$ mkdir -p api data/static data/media data/music config

Funkwhale が動作するには、いくつかの環境変数が必要です。これらは環境ファイル {{ic|/srv/funkwhale/config/env}} で定義されている必要があります。
{{ic|/etc/webapps/funkwhale/env.template}} にテンプレートがあります。これをコピーして、インストールに合わせて変更します。

 [funkwhale]$ cp /etc/webapps/funkwhale/env.template /srv/funkwhale/config/env

{{ic|FUNKWHALE_HOSTNAME}} 変数は、{{ic|/etc/hosts}} のホスト名に対応する必要があります。
{{ic|DJANGO_ALLOWED_HOSTS}} も、funkwhale インスタンスに到達するアドレスと一致する必要があります。
一意の {{ic|DJANGO_SECRET_KEY}} を生成し、インストールに応じてパスを変更する必要があります。

{{Tip|環境変数がロードされた状態で {{ic|funkwhale}} ユーザーとしていくつかのコマンドを実行する必要があるため、ログイン後に次のコマンドラインを使用できます:

 [funkwhale]$ export $(grep -v ^#  /srv/funkwhale/config/env {{!}} xargs)

便宜上、この行を {{ic|/srv/funkwhale/.bashrc}} (または使用しているシェル) にコピーすると、funkwhale ユーザーにログインするたびに自動的にロードされます。
}}

=== データベースのセットアップ ===

AUR から {{AUR|funkwhale-venv}} をインストールした場合は、{{ic|/usr/bin/funkwhale_manage}} を使用して {{ic|/usr/share/webapps/funkwhale/api/manage.py}} を実行します{{ic|funkwhale}} ユーザーとしてコマンドを実行します。

アプリケーションを起動する前にデータベースを初期化します:

 [funkwhale]$ funkwhale_manage migrate

Funkwhale インスタンスのスーパーユーザーを作成します:

 [funkwhale]$ funkwhale_manage createsuperuser

Web アプリの静的ファイルを収集します:

 [funkwhale]$ funkwhale_manage collectstatic

{{Note|{{ic|funkwhale_manage}} を使用しない場合は、まず Python virtualenv をアクティブにしてから、{{ic|funkwhale}} ユーザーとしてコマンドを実行する必要があります。

{{bc|
[funkwhale]$ source /usr/share/webapps/funkwhale/virtualenv/bin/activate
[funkwhale]$ python /usr/share/webapps/funkwhale/api/manage.py migrate
[funkwhale]$ python /usr/share/webapps/funkwhale/api/manage.py createsuperuser
[funkwhale]$ python /usr/share/webapps/funkwhale/api/manage.py collectstatic
[funkwhale]$ deactivate
}}

}}

== バージョンアップ ==

=== 自動 ===

AUR から {{AUR|funkwhale-venv}} をインストールした場合は、特別なことは何もありません。エラーが発生した場合は、{{ic|/usr/bin/funkwhale_manage}} スクリプトを使用して、{{ic|/usr/share/webapps/funkwhale/api/manage.py}} コマンドを実行します sudo を使用して (実行する必要があります))

{{Warning|
* サービスを再起動する前に、Apache または nginx の設定ファイルが変更されていないことを確認してください。互換性のない変更については、公式ドキュメントを参照してください。
}}

=== マニュアル ===

{{note|バージョン 1.3.0 より前では、AUR パッケージはアップストリームと同様に {{ic|funkwhale.target}} を使用した後、{{ic|funkwhale.service}} を使用していました。}}

AUR から {{AUR|funkwhale}} をインストールした場合は、次の手順に従ってください。

アップグレードする前に、{{ic|funkwhale.target}} を [[停止]] してください。

すべてのコマンドは、{{ic|funkwhale}} [[Funkwhale# Funkwhale ユーザー|ユーザー]] として入力する必要があります。

静的ファイルを再度収集する必要があります:

 [funkwhale]$ funkwhale_manage collectstatic --no-input

データベース移行を適用します:

 [funkwhale]$ funkwhale_manage migrate

{{Warning|
* サービスを再起動する前に、Apache または nginx の設定ファイルが変更されていないことを確認してください。互換性のない変更については、公式ドキュメントを参照してください。
}}

これらの手順をすべて完了すると、{{ic|funkwhale.target}} は再び [[ヘルプ:読み方#systemd ユニットのコントロール|起動状態]] になります。

{{Note|アップグレードの手順はすべて、公式ドキュメント [https://docs.funkwhale.audio/upgrading/index.html] に記載されています。}}

== 使い方 ==

アップストリームは、AUR パッケージとともにすでにインストールされている systemd サービスを提供します。

インスタンスを開始するには、{{ic|funkwhale.target}} を [[起動]] するだけです。

これにより 3 つのサービスが開始され、次のコマンドでステータスを確認できます:

 $ systemctl status funkwhale-\*

{{note|バージョン 1.3.0 より前では、AUR パッケージはアップストリームと同様に {{ic|funkwhale.target}} を使用した後、{{ic|funkwhale.service}} を使用していました。}}

== トラブルシューティング ==

https://docs.funkwhale.audio/admin/troubleshooting.html を参照してください。

=== プロキシログ ===

funkwhale の Apache ログ:

 $ tail -f /var/log/httpd/funkwhale/error.log