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