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