朔設定ガイド

主にUnixを想定した朔の設定ガイドです。朔 2.3.0以降に対応しています。簡単な使い方はチュートリアルをご覧ください。

設定ファイル

次の設定ファイルが順に読み込まれます。後で設定したものが優先されます。書式は同じです。 doc/sample.iniをご覧ください。

file/saku.ini
/usr/local/etc/saku/saku.ini
/etc/saku/saku.ini
~/.saku/saku.ini

shingetsu/config.py で設定する項目もありますが、ほとんどの場合は変更する必要はないと思います。

Apacheと組み合わせるときの設定

Apacheと朔を組み合わせて使う方法をご覧ください。 Apacheの設定サンプル、各種スクリプトは朔に同梱されています。スクリプトは通常 /usr/local/lib/saku/mkrss です。

Apacheと組み合わせるには server_name の設定が必要です。 server_name は bbs.shingetsu.info や bbs.shingetsu.info:8000 のように設定します。スクリプトを動かすにはさらに proxy_destination, apache_docroot の設定が必要です。

[Gateway]
server_name: bbs.shingetsu.info
[Path]
apache_docroot: %(var)s/www/shingetsu

保管庫との連携

ここでいう保管庫はmkarchive.pyで生成された、静的なHTMLで作られた保管庫です。これもまたApacheとの組み合わせです。

保管庫を生成するmkarchive.pyは朔に同梱されています。不適切な書き込みがないことを確認のうえ、このスクリプトを動かしてください。不適切な書き込みがあれば、それを削除してから動かしてください。スクリプトは通常 /usr/local/lib/saku/mkarchive です。

朔では次のような設定が必要です。 Apacheで archive_dir をドキュメントルートとするような archive_uri を設定してください。

[Path]
archive_dir: %(var)s/www/archive
[Gateway]
archive_uri: http://archive.shingetsu.info/

古い書き込みの定期的削除

古い書き込みが不要だという方は定期的に削除することをお勧めします。 save_record の値を秒単位で指定し、 save_size の値を整数で指定してください。 save_record の時間が経過し、最近の save_size 件には含まれないレコードが削除されます。例の2678400は1ヶ月の秒数です。

[Application Thread]
save_record: 2678400
save_size: 100

古い書き込みの取得

逆にできるだけ古い書き込みも集めたいという方はダウンロードの条件を緩くしてください。しかし転送量が増えることから、あまりお勧めはできません。

get_range は初回取得時、sync_rangeは定期的な取得時の条件です。指定した秒数が経っていない書き込みだけを取得します。 0を指定すると無限大を意味します。

[Application Thread]
get_range: 0
sync_range: 0

スパムフィルタ

spam.txtにスパムの条件を正規表現で列挙します。 spam.txtの位置は設定ファイルで変更できます。重要なのは書き込みがレコード形式に変換された状態でのマッチだということです。レコード形式は書き込みの削除時に確認画面で見ることができます。スパムを削除しながら、その条件を記述することができます。

1行目でファイルの文字コードを指定してください。