インストール方法

CuckooRemind をインストールするためには以下の環境が必要です

その他、Laravel 10系の必要要件に準じます

パッケージ版

zipファイルとして配布されているパッケージを展開することで使い始めることができます。

こちらのURLから最新版のzipファイルをダウンロードし、Apache2のドキュメントルート配下に設置します。

その後、設置したドキュメントルートに対応したURLにアクセスすることで初期設定画面が表示されれば設置が完了です。表示画面に従って初回設定を完了してください。

表示されない場合には設置ファイルの権限変更を行なってください

chmod -R 705 .

Gitリポジトリからソースコードを取得することで設定することができます。

cd /path/to/document-root/
git clone git@github.com:soramugi/cuckooremind.git .
composer install
npm install
npm run build

.env を作成して環境向けに設定を変更します

cp .env.example .env
touch database/database.sqlite
php artisan key:generate
php artisan migrate
vi .env

APP_URL=http://localhost # ホスティングするURLに変更
MAIL_FROM_ADDRESS="no-replay@example.com" # メール送信元としてホスティングするURLに変更

以上でホスティングするURLにアクセスすると表示することができます。初回はユーザー作成画面が表示されるため、指示に従いユーザー作成を行なってください。

定期的に通知を実行するためにcronを設定する必要があります。crontabが設定できるのであれば

* * * * * cd /path/to/document-root/ && php artisan schedule:run -q

を設定してください。

crontabが設定できない環境であれば、インストールした CuckooRemind の画面に従い API Tokenを作成し、

https://cuckooremind-domain.com/api/cron?token=<作成したAPI Token>

のURLを定期的にGETアクセスすることでcron実行が可能です。 Windowsのタスクスケジューラーや、Macのショートカットアプリ等で定期実行してください。