Skip to content

shirasagi/shirasagi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8a227bc · Apr 3, 2025
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SHIRASAGI

SHIRASAGI is Contents Management System.

Code Status

Ruby Coverage Status Code Climate GitHub version

Documentation

Platform

  • AlmaLinux, RockyLinux, Ubuntu
  • Ruby 3.1 or 3.2
  • Ruby on Rails 7.1
  • MongoDB 6.0 or 7.0
  • Unicorn
  • Node.js 20
  • Elasticsearch 7.1

Installation (Auto)

  • AlmaLinux8 の環境で実行してください。
  • 一般ユーザーで実行する場合はユーザーで実行する場合は、sudo が利用できることを確認してください。
  • パラメーターの"example.jp"には、ブラウザでアクセスする際のドメイン名または、IPアドレスを指定してください。
$ su - user-which-executes-shirasagi-server
$ curl https://raw.githubusercontent.com/shirasagi/shirasagi/master/bin/install.sh | bash -s example.jp

Installation (AlmaLinux)

  • 本手順は簡易的に動作確認を行う為の最小構成の手順となります。 正式にサービスとしてご利用の際は、フロントにNginx等のWEBサーバを立て、 セキュリティに配慮した設定を実施頂くことを推奨いたします。
    Nginxの導入につきましては開発マニュアルのNginxのインストール をご確認ください。

  • 拡張機能(ふりがな、読み上げ、オープンデータ等)や詳細なインストール手順は開発マニュアルをご確認ください。

パッケージのダウンロード

$ su -
# dnf -y install epel-release wget
# dnf config-manager --disable epel
# dnf --enablerepo=epel -y update epel-release
# dnf -y groupinstall "Development tools"
# dnf -y --enablerepo=epel,powertools install ImageMagick ImageMagick-devel openssl3

MongoDB のインストール

$ su -
# vi /etc/yum.repos.d/mongodb-org-7.0.repo
[mongodb-org-7.0]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/7/mongodb-org/7.0/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://pgp.mongodb.com/server-7.0.asc
# dnf install -y --enablerepo=mongodb-org-7.0 mongodb-org
# systemctl start mongod
# systemctl enable mongod

asdf のインストール

$ su -
# git clone https://github.com/asdf-vm/asdf.git ~/.asdf
# vi ~/.bashrc
---(追記)
. $HOME/.asdf/asdf.sh
. $HOME/.asdf/completions/asdf.bash
---
# source ~/.bashrc

Ruby のインストール

$ su -
# asdf plugin add ruby
# asdf install ruby 3.2.5
# asdf global ruby 3.2.5

Nodejs のインストール

$ su -
# asdf plugin add nodejs
# asdf install nodejs 20.17.0
# asdf global nodejs 20.17.0
# npm install -g yarn

SHIRASAGI のインストール

SHIRASAGI のダウンロード (stable)

$ su -
# git clone -b stable https://github.com/shirasagi/shirasagi /var/www/shirasagi

設定ファイルの設置と gem のインストール

$ su -
# cd /var/www/shirasagi
# cp -n config/samples/*.{yml,rb} config/
# bundle install --without development test
# ./bin/deploy

Web サーバの起動

$ su -
# bundle exec rake unicorn:start

サイトの作成

データベース(インデックス)の作成

$ su -
# bundle exec rake db:drop
# bundle exec rake db:create_indexes

新規サイトの追加

$ su -
# bundle exec rake ss:create_site data='{ name: "サイト名", host: "www", domains: "localhost:3000" }'

サンプルデータ (自治体サンプル) の投入

$ su -
# bundle exec rake db:seed name=demo site=www

サイトの確認

管理画面

http://localhost:3000/.mypage にアクセスするとログイン画面が表示されます。
サイト名のリンクをクリックすると、登録したデモデータを確認・編集することができます。
[ ユーザーID: admin , パスワード: pass ]

公開画面

http://localhost:3000/ にアクセスすると登録したデモサイトが表示されます。

開発・テスト環境

.envというファイルをプロジェクトルートに用意すれば各種設定をお好みのものに切り替えられます。

(設定例)

  • デフォルトでwarnになっているログレベルをdebugにしたい場合。
  • テスト時にデフォルトで実行されるカバレッジ計測を省きたい場合。
DEVELOPMENT_LOG_LEVEL=debug
ANALYZE_COVERAGE=disabled

その他機能の利用方法