78 lines
4.6 KiB
Markdown
78 lines
4.6 KiB
Markdown
# uwuzu for Docker Compose
|
|
uwuzuがDocker Composeで動きます。
|
|
※1: 一部バージョンでは動かない可能性があります。
|
|
※2: 動作保証は致しません。
|
|
※3: セキュリティ上の問題が発生する可能性があるため本番環境では推奨しません。
|
|
|
|
# 構造
|
|
## /.env
|
|
.env.exampleのコメントに従って入力してください。
|
|
|
|
## /src/
|
|
srcフォルダにuwuzuのリポジトリで配布されているZIPファイルを展開してください。
|
|
|
|
## /db/・/php/
|
|
設定ファイルやDockerfileなどがあります。
|
|
動作しない場合は適宜修正してください。
|
|
余裕があればIssue・プルリクエストのご協力をお願いします。
|
|
|
|
# 前提条件
|
|
## 必須
|
|
Docker Composeが必要です。
|
|
※Windows containersは利用できません。
|
|
## 動作確認済み
|
|
```
|
|
OS: Windows 11 23H2
|
|
WSLカーネル: 2.6.1.0
|
|
Docker Compose: v2.40.2-desktop.1
|
|
uwuzu:
|
|
- v1.5.4
|
|
- v1.6.0
|
|
- v1.6.6
|
|
```
|
|
|
|
# 使い方
|
|
## 構築
|
|
2つの方法がありますが、どちらの場合も絶対にホスト側の/src/.source-flagを削除しないでください。(コンテナ内では自動的に削除されます)
|
|
uwuzu for Docker ComposeではGitやDockerfileの都合で.source-flagを必要とし、/srcのファイル/ディレクトリ数を参照して自動ダウンロードを判断します。
|
|
.source-flagを含めたsrcフォルダのファイル/ディレクトリ数が1つ以下の場合に自動ダウンロードを実行する仕様です。
|
|
|
|
### 自動ダウンロードを使用する
|
|
0. `/.env.exaple`のコメントに従って`/.env`を作成。
|
|
1. `/php/apache2.conf`、`/php/php.ini`を適宜変更。
|
|
2. プロジェクトルートで`docker-compose build`を実行。
|
|
以降は[独自のソースコード(改変uwuzu)を使用する](#独自のソースコード(改変uwuzu)を使用する)の手順5から同等ですのでそちらをご確認ください。
|
|
|
|
### 独自のソースコード(改変uwuzu)を使用する
|
|
0. `/.env.example`のコメントに従って`/.env`を作成。
|
|
1. `/src/`以下に[uwuzuのリポジトリで配布されているZIPファイル](https://github.com/Daichimarukana/uwuzu/releases)を展開。
|
|
2. `/php/apache2.conf`、`/php/php.ini`を適宜変更。
|
|
3. プロジェクトルートで`docker-compose build`を実行。
|
|
4. `docker-compose up`でuwuzu及びMariaDBが起動します。
|
|
5. ブラウザでuwuzuの`/admin`に移動し初期設定を行います。
|
|
6. uwuzuの表示に従って初期設定を進めます。
|
|
データベース名には`uwuzu`、ホストには`db`を使用してください。`uwuzu`データベースは自動的に作成されています。
|
|
ユーザーには`root`、あるいは`/.env`で設定した`MARIADB_USER`を使用し、パスワードは`/.env`で設定した`MARIADB_ROOT_PASSWORD`や`MARIADB_PASSWORD`を使用してください。
|
|
これにてuwuzuの構築は完了です。
|
|
|
|
今後uwuzuの破壊的変更により`/db/`や`/php/`の設定が利用できなくなる可能性があります。
|
|
その場合はIssueを立てuwuzuのバージョンアップを報告するか対応を待機、あるいは自身で設定を変更してください。
|
|
(余裕があれば動作した設定をプルリクエストするご協力をお願いします。)
|
|
|
|
## アップデート
|
|
※1: 飛び級アップデートは利用できません。リリース順にアップデートしてください。
|
|
※2: アップデート後にuwuzuが破損する可能性があるためバックアップをしてから行ってください。
|
|
※3: .envの`UWUZU_SOURCE_TAG`/`UWUZU_SOURCE_FILENAME`はビルドする際のものです。
|
|
|
|
0. [uwuzuのリリースノート](https://docs.uwuzu.com/docs/aboutuwuzu/releasenote)を参照し変更が必要な対応を行ってください。
|
|
1. [uwuzuのリリース](https://github.com/Daichimarukana/uwuzu/releases)を参照し対象のバージョンのZIPファイルをダウンロード。
|
|
2. `/settings_admin/update_admin.php`にアクセスし行程1でダウンロードしたZIPファイルを指定。
|
|
3. 確認画面に移動するので問題がない場合はアップデートボタンを選択してください。
|
|
これにてuwuzuのアップデートは完了です。
|
|
|
|
### 自動アップデートが使用できない場合
|
|
[uwuzuの公式ドキュメント](https://docs.uwuzu.com/docs/serveradmin/update#1-%E8%87%AA%E5%8B%95%E3%82%A2%E3%83%83%E3%83%97%E3%83%87%E3%83%BC%E3%83%88%E3%81%8C%E4%BD%BF%E3%81%88%E3%81%AA%E3%81%84%E5%A0%B4%E5%90%88)に従ってアップデートしてください。
|
|
|
|
# 備考
|
|
問題が発生した場合はIssueを立ててください。
|