SHIRASAGI 開発マニュアル

リポジトリ

• GitHub
  • shirasagi/shirasagi
  • ブランチ運用ルール

インストール手順

• 自動インストール
  • Vagrant
  • install.sh
• 手動インストール
  • CentOS
  • RHEL8 系
  • Ubuntu
  • Linux Mint 21.1
• ミドルウェア
  • Unicorn
  • Nginx
  • Apache
  • Fuseki （オープンデータ利用時）
  • Elasticsearch & Fess （GWS の全文検索、CMS のサイト内検索利用時）
  • MongoDB 推奨設定

アップデート手順

• バックアップとリストア
• Ruby
• MongoDB
  • v4.4 to v6.0
• SHIRASAGI
  • オープンデータのレポート機能
  • 全文検索インデックス

利用手順

• グループウェアの始め方
• グループウェアの新しいテナントの作成方法
• ウェブメールの始め方

機能と設定

• システム全般

  • 管理コマンド一覧
  • 環境設定
    • OEM 開発
  • 定期実行
  • 非同期実行 / バッググラウンドジョブ
  • セッションタイムアウト
  • セッションの secure 化
  • 分散構成(同期/非レプリカセット)
  • メール送信 (SMTP)
  • ファイルサイズ制限
  • 日本語ファイル名のダウンロード
  • アップロード制限（無害化）
  • 信頼できる URL の設定
  • 日英（多言語・バイリンガル）対応
  • OAuth 2.0 IdP

• 認証

  • ログイン
  • OAuth 認証
  • SAML 認証の疎通確認
  • Shibboleth 認証

• CMS

  • Basic 認証環境での設定
  • サブディレクトリ設定
  • リンクチェック設定
  • 端末別表示
  • ふりがな
  • 音声読み上げ
  • Liquid 形式レイアウト
  • 条件分岐構文
  • 閲覧履歴とレコメンド
  • メール取込
  • リンクページ
  • miChecker
  • 組織変更
  • サイトのデータ移行
  • 他サイト/サブサイトのページ・フォルダー参照
  • 特定フォルダー・パーツの無効化
  • 不適切な公開 HTML 削除
  • サイト内検索

• オープンデータ

  • ハーベスト機能

• グループウェア

  • 全文検索対象機能
  • 閲覧権限の公開範囲などの既定値
  • Q&A

• CMS 外部連携

  • 外国語自動翻訳機能
  • OGP と Twitter Card 設定
  • SNS 投稿連携
  • LINE 連携
  • 気象庁防災情報 XML 連携（PULL 型）
  • 5374 連携

サイト構築資料

• マルチテナントサイトの構築について

開発資料

• ソースコード
  • Gems
  • DB 定義
• 基本情報
  • ディレクトリ構成
  • JavaScript 構成
  • システム設定 (config)
  • モデルアドオン設計
  • 権限/ロール
  • モデルの基底モジュール (SS::Document)
  • ファイル機能（SS::File）
  • モーダル検索 UI (SearchUI)
  • Job の開発
  • 無害化処理 (サニタイザー)
  • ダブルクリック防御
  • Guard
• CMS
  • CMS の主要モデル
  • 公開系の開発
  • リストノード/パーツとループ HTML 変数の定義と拡張
  • ループ HTML 変数の一覧と使用例(template_variable_handler)
  • template_variable_handler を使用しないテンプレート
  • アクセシビリティチェック機能
• Web メール
  • ウェブメール開発環境の構築
  • Docker を用いたウェブメールテスト環境の構築
  • IMAP のデバッグ
• テスト
  • Rspec
  • Rspec の運用
  • Rspec w/ Google Chrome
  • Rspec実行時に指定できる環境変数
  • 全文検索機能の開発とテスト
• Windows11でのシラサギ開発

トラブルシューティング

• インストール
• 画像認証
• メール送信
• シラサギが過負荷になる（音声読み上げが原因の場合）
• Rails 6.1 への更新と Gem の最新化
• MongoDB 6.0 / Mongoid 8.0 への更新

シラサギ公式サイトの FAQ

CKEditor のカスタマイズ方法や音声読み上げのスキップ方法など、このサイト上で解説していない情報がシラサギ公式サイトの FAQ にはあります。シラサギ公式サイトの FAQ も確認してみてください。

• シラサギ公式サイトの FAQ

Repository: https://github.com/shirasagi/shirasagi.github.io