nginxとuwsgiを使ってTracをホストしよう

このTracをセットアップするのに多くの時間を費やし、文献を読みあさったのでここに手順やハマりどころをまとめておきます。

そこらの文献というのはなぜかコマンドをどの権限やパスで実行するか明記していないケースがあるので、この記事ではコマンドの説明をするときはbashっぽくプロンプトの部分から記述します。

  1. なんかサーバを用意します(当サーバはAmazon EC2上のUbuntu 12.04.2)
    以降、ホスト名はreimuと表します(このホストがreimu.x86-64.jpだから)
  1. 必要なものをパッケージマネージャなり公式サイトなりから引っ張ってきます。
    わたしはaptを使って手を抜きました。依存環境などもまるまる降ってくるし、アップデートの適用もシステムと一緒にできるという恩恵にあずかれます。
    [email protected] ~:# apt-get install nginx uwsgi uwsgi-plugin-python trac trac-git
    trac-gitはTracでgit使いたいから入れておいたもので、必須ではありません。
    で、uwsgiって結局なんなん: Uwsgi?
  1. わたしはWebサイトごとにユーザを作るスタイルを採用しているので、Trac用にユーザを作っちゃいます。 
    [email protected] ~:# adduser -G www-data trac
    nginxが走るグループは、環境によってはwww-dataではないかもしれません(httpdとか)
    ユーザ分けとかどうでもいい場合はwww-dataさんが参照できるディレクトリを用意するだけで大丈夫です。
  1. Tracのプロジェクトが入るディレクトリを適当に作り、Tracに付属しているTrac-admin?コマンドでそのディレクトリをTrac化します。
    これは通常ユーザ(この記事の例ではtrac, Trac用のユーザを作らなかった場合はwww-data)で行います。 
    [email protected] ~:$ mkdir your_trac_project
[email protected] ~:$ trac-admin ~/your_trac_project initenv
    initenvを行っているときに、プロジェクトの名称とデータベースファイルのパスを決められます。
    これがTracのタイトルとして反映されます。たとえばこのTracなら真剣な悪ふざけになっています。 どうやらUTF-8なら2バイト文字でもいいみたいです。
  1. このへんでTracの管理者アカウントを登録しておきましょう。 
    [email protected] ~:$ trac-admin ~/your_trac_project permission add foo TRAC_ADMIN
    これで、ユーザfooが管理者になりましたので、fooとしてhttp-auth-basic(以下Basic認証と記述)でログインできるように設定します(後述)。

  1. Tracについての、uwsgi用とnginx用のconfigを作ります。
    わたしはこうしました:
/etc/uwsgi/apps-available/trac.xml
<uwsgi>
    <socket>127.0.0.1:7777</socket>
    <plugin>python</plugin> <!--この行が意外と重要-->
    <env>TRAC_ENV=/home/trac/project-directory</env>
    <module>trac.web.main:dispatch_request</module>
</uwsgi>
/etc/nginx/sites-available/trac
server {
    listen 80;
    listen 443 ssl;
    server_name x86-64.jp;
    ssl_certificate /path/to/ssl-cert.pem;
    ssl_certificate_key /path/to/ssl-key.key;
    root /home/trac/your_trac_project;
    
    location /favicon.ico { }
    location /robots.txt { }

    if ($scheme = http) {
    	return 301 https://$server_name$request_uri;
    }
    
    location / {
    	include uwsgi_params;
    	uwsgi_pass 127.0.0.1:7777;
    }

    location /login {
    	include uwsgi_params;
    	uwsgi_param REMOTE_USER $remote_user;
    	uwsgi_pass 127.0.0.1:7777;
    	auth_basic "Trac";
    	auth_basic_user_file "/path/to/your/.htpasswd";
    }
}
uwsgi用のconfで書いたソケットはportが7777なので、こちらのconfでもuwsgi_passを7777に設定しておきます。
このようにして、nginxにアクセスがあったとき、uwsgiを通してTracのコンテンツを引っ張りにいく設定にします。 ちなみにこのTracはSSL-enabledなので、ところどころSSLに関する設定が入っています。
  1. htpasswdを使って、Basic認証に使うアカウントを生成します。
    Apacheを入れていないUbuntuではそんなコマンドないかもしれないですが、apache-utilsをインストールすればOKです(記事は省略) 
    [email protected] ~:$ htpasswd -c /path/to/your/.htpasswd foo
[email protected] ~:$ chgrp www-data /path/to/your/.htpasswd
[email protected] ~:$ chmod 750 /path/to/your/.htpasswd
    これによってユーザfooが含まれる.htpasswdが生成されたので、このユーザでログインすることでTracのWebインタフェースからの管理ができるようになりました。
    個人的にはここでroot以外が.htpasswdを読めるのがきもい。まあしょうがない。
  1. 上で書いたconfigをenableします。 
    [email protected] ~:# ln -s /etc/nginx/sites-available/trac /etc/nginx/sites-enabled/trac
[email protected] ~:# ln -s /etc/uwsgi/apps-available/trac.xml /etc/uwsgi/apps-enabled/trac.xml
  1. uwsgiとnginxをrestartして完成。 
    [email protected] ~:# service uwsgi restart
[email protected] ~:# service nginx restart

ああそういえば:

エラーが発生したときは、結構な確率でパーミッションがおかしいです。
とくにTracを運用するにあたってwww-dataが読み書きできなくてはいけないファイルは、

  • your_trac_project/conf/trac.ini
  • your_trac_project/db/trac.db

が大事です。これらのファイルについてwww-dataがrとwの権限を持っているかチェックしましょう。

それからハマりどころとして、uwsgiの設定にてPythonのプラグインを使うことを明記しないとちゃんと動かなかったのでメモ。

ざっとこんなところかしら。なんか抜けがある気がするので暇な時に検証します。

参考文献

  1. ​TracInstallUbuntu
  2. ​TracNginxRecipe
  3. ​ラフなラボ: Nginx + uwsgi で Trac環境を作った時のメモ
  4. ​Cookbook recipe for nginx/uwsgi woes

Comments

No comments.