Added documentation on installation of `ffmpeg` and `ImageMagick` dependencies.
[akkoma] / docs / installation / debian_based_jp.md
1 # Pleromaの入れ方
2 ## 日本語訳について
3
4 この記事は [Installing on Debian based distributions](Installing on Debian based distributions) の日本語訳です。何かがおかしいと思ったら、原文を見てください。
5
6 ## インストール
7
8 このガイドはDebian Stretchを利用することを想定しています。Ubuntu 16.04や18.04でもおそらく動作します。また、ユーザはrootもしくはsudoにより管理者権限を持っていることを前提とします。もし、以下の操作をrootユーザで行う場合は、 `sudo` を無視してください。ただし、`sudo -Hu pleroma` のようにユーザを指定している場合には `su <username> -s $SHELL -c 'command'` を代わりに使ってください。
9
10 ### 必要なソフトウェア
11
12 - PostgreSQL 9.6以上 (Ubuntu16.04では9.5しか提供されていないので,[](https://www.postgresql.org/download/linux/ubuntu/)こちらから新しいバージョンを入手してください)
13 - `postgresql-contrib` 9.6以上 (同上)
14 - Elixir 1.8 以上 ([Debianのリポジトリからインストールしないこと!!! ここからインストールすること!](https://elixir-lang.org/install.html#unix-and-unix-like)。または [asdf](https://github.com/asdf-vm/asdf) をpleromaユーザーでインストールしてください)
15 - `erlang-dev`
16 - `erlang-nox`
17 - `git`
18 - `build-essential`
19 - `cmake`
20 - `ffmpeg`
21 - `ImageMagick`
22
23 #### このガイドで利用している追加パッケージ
24
25 - `nginx` (おすすめです。他のリバースプロキシを使う場合は、参考となる設定をこのリポジトリから探してください)
26 - `certbot` (または何らかのLet's Encrypt向けACMEクライアント)
27
28 ### システムを準備する
29
30 * まずシステムをアップデートしてください。
31 ```
32 sudo apt update
33 sudo apt full-upgrade
34 ```
35
36 * 上記に挙げたパッケージをインストールしておきます。
37 ```
38 sudo apt install git build-essential postgresql postgresql-contrib cmake ffmpeg imagemagick
39 ```
40
41
42 ### ElixirとErlangをインストールします
43
44 * Erlangのリポジトリをダウンロードおよびインストールします。
45 ```
46 wget -P /tmp/ https://packages.erlang-solutions.com/erlang-solutions_2.0_all.deb
47 sudo dpkg -i /tmp/erlang-solutions_2.0_all.deb
48 ```
49
50 * ElixirとErlangをインストールします、
51 ```
52 sudo apt update
53 sudo apt install elixir erlang-dev erlang-nox
54 ```
55
56 ### Pleroma BE (バックエンド) をインストールします
57
58 * Pleroma用に新しいユーザーを作ります。
59
60 ```
61 sudo useradd -r -s /bin/false -m -d /var/lib/pleroma -U pleroma
62 ```
63
64 **注意**: Pleromaユーザとして単発のコマンドを実行したい場合はは、`sudo -Hu pleroma command` を使ってください。シェルを使いたい場合は `sudo -Hu pleroma $SHELL`です。もし `sudo` を使わない場合は、rootユーザで `su -l pleroma -s $SHELL -c 'command'` とすることでコマンドを、`su -l pleroma -s $SHELL` とすることでシェルを開始できます。
65
66 * Gitリポジトリをクローンします。
67 ```
68 sudo mkdir -p /opt/pleroma
69 sudo chown -R pleroma:pleroma /opt/pleroma
70 sudo -Hu pleroma git clone -b stable https://git.pleroma.social/pleroma/pleroma /opt/pleroma
71 ```
72
73 * 新しいディレクトリに移動します。
74 ```
75 cd /opt/pleroma
76 ```
77
78 * Pleromaが依存するパッケージをインストールします。Hexをインストールしてもよいか聞かれたら、yesを入力してください。
79 ```
80 sudo -Hu pleroma mix deps.get
81 ```
82
83 * コンフィギュレーションを生成します。
84 ```
85 sudo -Hu pleroma mix pleroma.instance gen
86 ```
87 * rebar3をインストールしてもよいか聞かれたら、yesを入力してください。
88 * このときにpleromaの一部がコンパイルされるため、この処理には時間がかかります。
89 * あなたのインスタンスについて、いくつかの質問されます。この質問により `config/generated_config.exs` という設定ファイルが生成されます。
90
91
92 * コンフィギュレーションを確認して、もし問題なければ、ファイル名を変更してください。
93 ```
94 mv config/{generated_config.exs,prod.secret.exs}
95 ```
96
97 * 先程のコマンドで、すでに `config/setup_db.psql` というファイルが作られています。このファイルをもとに、データベースを作成します。
98 ```
99 sudo -Hu pleroma mix pleroma.instance gen
100 ```
101
102 * そして、データベースのマイグレーションを実行します。
103 ```
104 sudo -Hu pleroma MIX_ENV=prod mix ecto.migrate
105 ```
106
107 * これでPleromaを起動できるようになりました。
108 ```
109 sudo -Hu pleroma MIX_ENV=prod mix phx.server
110 ```
111
112 ### インストールの最終段階
113
114 あなたの新しいインスタンスを世界に向けて公開するには、nginx等のWebサーバやプロキシサーバをPleromaの前段に使用する必要があります。また、Pleroma のためにシステムサービスファイルを作成する必要があります。
115
116 #### Nginx
117
118 * まだインストールしていないなら、nginxをインストールします。
119 ```
120 sudo apt install nginx
121 ```
122
123 * SSLをセットアップします。他の方法でもよいですが、ここではcertbotを説明します。
124 certbotを使うならば、まずそれをインストールします。
125 ```
126 sudo apt install certbot
127 ```
128 そしてセットアップします。
129 ```
130 sudo mkdir -p /var/lib/letsencrypt/
131 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --standalone
132 ```
133 もしうまくいかないときは、nginxが正しく動いていない可能性があります。先にnginxを設定してください。ssl "on" を "off" に変えてから再試行してください。
134
135 ---
136
137 * nginxの設定ファイルサンプルをnginxフォルダーにコピーします。
138 ```
139 sudo cp /opt/pleroma/installation/pleroma.nginx /etc/nginx/sites-available/pleroma.nginx
140 sudo ln -s /etc/nginx/sites-available/pleroma.nginx /etc/nginx/sites-enabled/pleroma.nginx
141 ```
142
143 * nginxを起動する前に、設定ファイルを編集してください。例えば、サーバー名、証明書のパスなどを変更する必要があります。
144 * nginxを再起動します。
145 ```
146 sudo systemctl enable --now nginx.service
147 ```
148
149 もし証明書を更新する必要が出てきた場合には、nginxの関連するlocationブロックのコメントアウトを外し、以下のコマンドを動かします。
150
151 ```
152 sudo certbot certonly --email <your@emailaddress> -d <yourdomain> --webroot -w /var/lib/letsencrypt/
153 ```
154
155 #### 他のWebサーバやプロキシ
156 これに関してはサンプルが `/opt/pleroma/installation/` にあるので、探してみてください。
157
158 #### Systemd サービス
159
160 * サービスファイルのサンプルをコピーします。
161 ```
162 sudo cp /opt/pleroma/installation/pleroma.service /etc/systemd/system/pleroma.service
163 ```
164
165 * サービスファイルを変更します。すべてのパスが正しいことを確認してください
166 * サービスを有効化し `pleroma.service` を開始してください
167 ```
168 sudo systemctl enable --now pleroma.service
169 ```
170
171 #### 初期ユーザの作成
172
173 新たにインスタンスを作成したら、以下のコマンドにより管理者権限を持った初期ユーザを作成できます。
174
175 ```
176 sudo -Hu pleroma MIX_ENV=prod mix pleroma.user new <username> <your@emailaddress> --admin
177 ```
178
179 #### その他の設定とカスタマイズ
180
181 {! backend/installation/further_reading.include !}
182
183 ## 質問ある?
184
185 インストールについて質問がある、もしくは、うまくいかないときは、以下のところで質問できます。
186
187 * [#pleroma:matrix.org](https://matrix.heldscal.la/#/room/#freenode_#pleroma:matrix.org)
188 * **Freenode** の **#pleroma** IRCチャンネル