Skip to content

Commit ba403b3

Browse files
authored
Merge pull request #17 from msmsrep/dev
紹介ページとユーザーガイドを3つの配布方法に合わせて更新する
2 parents 06f0e64 + c4b181f commit ba403b3

11 files changed

Lines changed: 150 additions & 87 deletions

File tree

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# リリース(タグ v1.2.3 の push で起動)
22
# 1. ビルドとテスト(ci.yml)
3-
# 2. 自己完結版 ZIP(win-x64 / linux-x64)を作って GitHub Release に添付する(build/Pack-Zip.ps1)
3+
# 2. 自己完結版 ZIP(win-x64 / linux-x64)とサンプルCSVの ZIP を作って GitHub Release に添付する(build/Pack-Zip.ps1)
44
# 3. コンテナイメージ(linux/amd64・linux/arm64)を GHCR に登録する(Dockerfile)
55
# v1.2.3-rc.1 のようなプレリリースのタグは Release をプレリリース扱いにし、イメージに latest を付けない
66
# MSIX(Microsoft Store)は署名と提出が手作業なので対象外(docs-dev/MsixRelease.md)

‎Readme.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ APIが同一オリジンでWebクライアントも配信します。
55

66
- **紹介ページ(画面写真でひととおり見る)**: [Parallel Factory MES の紹介](https://msmsrep.github.io/ParallelFactoryMES/intro.html)
77
- **ユーザーガイド(操作マニュアル)**: [ユーザーガイド](https://msmsrep.github.io/ParallelFactoryMES/)
8+
- **入手**: [Microsoft Store](https://apps.microsoft.com/detail/9p9fqjzh23hc?hl=ja-JP&gl=JP)(1台で試す)/[ZIP](https://github.com/msmsrep/ParallelFactoryMES/releases/latest)(Windows / Linux)/Docker `ghcr.io/msmsrep/parallelfactorymes`
89

910
## ライセンス
1011

@@ -94,12 +95,14 @@ DBファイル(`mesapp.db`)とJWT署名鍵(`jwt-signing.key`)は**デー
9495

9596
書き方の見本として、そのまま取り込めるサンプルデータ一式を [`samples/master-csv/`](samples/master-csv/) に置いています
9697
(ファイル名の番号順に取り込むと、製造指図から出荷まで試せる状態になります)。
98+
ZIPにしたものを Releases に添付しています([マスタ](https://github.com/msmsrep/ParallelFactoryMES/releases/latest/download/samples-master-csv.zip)・[実績](https://github.com/msmsrep/ParallelFactoryMES/releases/latest/download/samples-actual-csv.zip))。
9799

98100
## 配布・本番相当の実行
99101

100102
ビルド済みのものを使う場合(手順の詳細は [管理者向け運用](docs/operations.md)):
101103

102-
- **ZIP(自己完結版・.NET不要)**: [Releases](https://github.com/msmsrep/ParallelFactoryMES/releases) から
104+
- **Microsoft Store 版(1台で試す)**: [Microsoft Store](https://apps.microsoft.com/detail/9p9fqjzh23hc?hl=ja-JP&gl=JP) からインストールします。サーバー不要で、ほかの端末からは接続できません
105+
- **ZIP(自己完結版・.NET不要)**: [Releases](https://github.com/msmsrep/ParallelFactoryMES/releases/latest) から
103106
`ParallelFactoryMES-<版>-win-x64.zip` / `-linux-x64.zip` を取得し、展開して `start.cmd`(Linux は `sh start.sh`)で起動します(ポート 5000)
104107
- **Docker(amd64 / arm64)**: `docker compose up -d` で起動します(ポート 8080。PostgreSQL 付きは `compose.postgres.yaml`)
105108

‎Spec.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@
9393
改訂92: 2026-09-21(**3プロバイダー分のマイグレーションをまとめて追加するスクリプト**(`scripts/Migrations.ps1`)を用意し、4章の将来拡張から「3プロバイダー分を作る運用の省力化」を外した。1つのマイグレーションで3プロバイダーを兼ねる形は、列の型がプロバイダーごとに生成されるため手修正が毎回必要になり採らない。あわせて、マイグレーションに生SQLを書かない規約を4章に加えた)
9494
改訂93: 2026-09-22(7.8節:ストア提出で「予約していない表示名」として弾かれたため、MSIXの表示名をマニフェストへの直書きから`build/msix-identity.json`の`DisplayName`に移し、予約名と一致させる旨を明記)
9595
改訂94: 2026-09-22(**Zip配布とDocker配布を実装した**(7.2節。Phase 10完了)。自己完結版zip(win-x64 / linux-x64)とコンテナイメージ(linux/amd64・arm64、GHCR)を、タグpushでGitHub Actionsから公開する。7.7節のDocker構成のバックアップをボリューム退避の手順に改め、9章の構成を実配置に合わせた。あわせて、Linuxで`~/.local/share`が未作成のときデータ保存先がカレントディレクトリになる不具合を直した(4章`MesAppDataDirectory`))
96+
改訂95: 2026-09-22(7.2節:リリースにサンプルCSVのzipを添付することにした。紹介ページとユーザーガイドを3つの配布方法(Microsoft Store・zip・Docker)に合わせて更新)
9697
参考: みんなのMES(min-MES) https://min-mes.com/ / OSS: https://github.com/mihatama/open-mes-project
9798

9899
---
@@ -573,7 +574,7 @@ DBはバックエンド(MesApp.Api)のみが保持し、既定はSQLiteと
573574

574575
### 7.2 配布形態
575576
- **Windows Store(MSIX・単独PC向け)**: MesApp.Desktop。API・DB・Webクライアントを1つのパッケージに同梱し、1台のPCで完結して動作させる(7.8節)
576-
- **Zip配布**: MesApp.Api(Webクライアント静的ファイル同梱)を**自己完結版**(win-x64 / linux-x64。配布先に.NETランタイム不要)で発行してzip化し、社内サーバー等に手動配置できるようにする(`build/Pack-Zip.ps1`)。起動スクリプト(`start.cmd` / `start.sh`)・LICENSE・対応ソースの所在(コミット)を同梱する。zipはUnixの実行権限を保持しないため、`start.sh`が起動前に実行権限を付ける
577+
- **Zip配布**: MesApp.Api(Webクライアント静的ファイル同梱)を**自己完結版**(win-x64 / linux-x64。配布先に.NETランタイム不要)で発行してzip化し、社内サーバー等に手動配置できるようにする(`build/Pack-Zip.ps1`)。起動スクリプト(`start.cmd` / `start.sh`)・LICENSE・対応ソースの所在(コミット)を同梱する。zipはUnixの実行権限を保持しないため、`start.sh`が起動前に実行権限を付ける。リリースにはサンプルCSVのzip(`samples-master-csv.zip` / `samples-actual-csv.zip`)も添付する(リポジトリを持たないzip・ストア版の利用者が取込画面にそのまま渡せるよう。名前に版数を入れず`releases/latest/download/`の固定リンクで案内する)
577578
- **Docker配布**: MesApp.Api(Webクライアント同梱)をコンテナイメージ化し(`Dockerfile`。linux/amd64・linux/arm64)、`ghcr.io/msmsrep/parallelfactorymes`で公開する。非rootで動かし、DB(SQLite)とJWT署名鍵は`/data`ボリューム(`MESAPP_DATA_DIR=/data`)に置く。`TZ`の既定は`Asia/Tokyo`(業務日付の境界に効くため)。起動例として`compose.yaml`(SQLite)と`compose.postgres.yaml`(PostgreSQL)を置く。HTTPSはコンテナでは扱わず前段のリバースプロキシで終端する
578579
- **リリースの自動化**: タグ`vX.Y.Z`のpushでGitHub Actions(`.github/workflows/release.yml`)がビルド・テストの後にzipをGitHub Releaseへ添付し、イメージをGHCRへ登録する。版数はタグから取り(`-p:Version`)、既定値は`Directory.Build.props`。`-`を含むタグはプレリリース扱いにしてイメージに`latest`を付けない。MSIXは署名とストア提出が手作業のため対象外。push・PRごとのビルドとテストは`.github/workflows/ci.yml`(Windows。MesApp.Desktopを含むため)
579580
- MesApp.Client.Webは必ずMesApp.Apiが配信する(別配信は行わない。APIと同一オリジンに置き、CORSや配置の組み合わせを増やさないため)

‎build/Pack-Zip.ps1‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
.DESCRIPTION
66
自己完結版なので配布先に .NET / ASP.NET Core Runtime は要らない。
77
ZIP には起動スクリプト(start.cmd / start.sh)・LICENSE・ソースの所在(AGPL-3.0 の対応ソース)を同梱する。
8+
あわせて、取込画面に渡せるサンプルCSVのZIP(samples-master-csv.zip / samples-actual-csv.zip)を作る。
89
910
ZIP は Unix の実行権限を保持しないため、start.sh が起動前に MesApp.Api へ実行権限を付ける
1011
(利用者は `sh start.sh` で起動する)。
@@ -121,3 +122,13 @@ Parallel Factory MES $Version($rid・自己完結版)
121122
Remove-Item $stage -Recurse -Force
122123
Write-Host "作成: $zip ($([math]::Round((Get-Item $zip).Length / 1MB, 1)) MB)"
123124
}
125+
126+
# --- 4. サンプルCSV -------------------------------------------------------------------------
127+
# ZIP版・ストア版の利用者はリポジトリを持たないため、取込画面にそのまま渡せる形で添付する。
128+
# 版数を名前に入れず、releases/latest/download/<名前> の固定リンクで案内できるようにする
129+
foreach ($kind in 'master-csv', 'actual-csv') {
130+
$zip = Join-Path $OutputDirectory "samples-$kind.zip"
131+
if (Test-Path $zip) { Remove-Item $zip -Force }
132+
[IO.Compression.ZipFile]::CreateFromDirectory((Join-Path $repoRoot "samples/$kind"), $zip)
133+
Write-Host "作成: $zip"
134+
}

‎docs/getting-started.md‎

Lines changed: 46 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,35 +9,67 @@ next_url: basics.html
99
next_title: 画面構成と共通操作
1010
---
1111

12+
## 入手方法を選ぶ
13+
14+
| 方法 | 向いている使い方 | 入手先 | 開くURL |
15+
|---|---|---|---|
16+
| Microsoft Store 版 | 1台のPCで機能を試す・手順を検証する(ほかの端末からは接続できません) | [Microsoft Store](https://apps.microsoft.com/detail/9p9fqjzh23hc?hl=ja-JP&gl=JP) | アプリの画面がそのまま開きます |
17+
| ZIP(Windows / Linux) | 社内LANのサーバーに置き、現場の端末からブラウザで使う | [GitHub Releases](https://github.com/msmsrep/ParallelFactoryMES/releases/latest) | `http://<サーバー>:5000` |
18+
| Docker(amd64 / arm64) | 同上。コンテナで動かす | `ghcr.io/msmsrep/parallelfactorymes` | `http://<サーバー>:8080` |
19+
| ソースから動かす | 開発・改造 | [GitHub](https://github.com/msmsrep/ParallelFactoryMES) | `http://localhost:5288` |
20+
21+
どの方法も無償で、アクティベーションやライセンスキーは不要です。ソースから動かす場合を除き、.NET のインストールも要りません。
22+
1223
## 利用に必要なもの
1324

1425
| 項目 | 内容 |
1526
|---|---|
16-
| サーバー | .NET 10 SDK(実行のみなら ASP.NET Core 10 ランタイム)がインストールされたPC 1台 |
27+
| サーバー | Windows / Linux(x64)のPC 1台、または Docker が動く環境(amd64 / arm64)。Store 版は Windows 10(2004 以降)/ 11 |
1728
| データベース | 不要。既定ではSQLiteのファイル(`mesapp.db`)が自動生成されます。PostgreSQL / SQL Server も使えます([管理者向け運用](operations.html#database)) |
1829
| 利用端末 | モダンブラウザ(Chrome / Edge など)。専用アプリのインストールは不要です |
1930
| ネットワーク | 端末からサーバーのURLにアクセスできること |
2031

21-
アクティベーションやライセンスキーは不要です。サーバーにアクセスできる端末はすべて利用できます。
32+
## 起動する
33+
34+
### Microsoft Store 版
35+
36+
[Microsoft Store](https://apps.microsoft.com/detail/9p9fqjzh23hc?hl=ja-JP&gl=JP) からインストールし、スタートメニューの **Parallel Factory MES** を開きます。
37+
初期管理者は自動で作られ、ユーザー名と初期パスワードが画面の上に表示されます(下の「初期管理者アカウントを作る」は不要です)。
38+
39+
### ZIP
40+
41+
<ol class="steps">
42+
<li><a href="https://github.com/msmsrep/ParallelFactoryMES/releases/latest">Releases</a> から <code>ParallelFactoryMES-&lt;版&gt;-win-x64.zip</code>(Linux は <code>-linux-x64.zip</code>)をダウンロードして展開します。</li>
43+
<li>Windows は <strong>start.cmd</strong> をダブルクリック、Linux は <code>sh start.sh</code> を実行します。</li>
44+
<li>ブラウザで <code>http://localhost:5000</code> を開きます。</li>
45+
</ol>
2246

23-
## サーバーを起動する
47+
<div class="warn">
48+
<p>Windows で「WindowsによってPCが保護されました」と表示された場合は、展開する前にZIPファイルのプロパティを開き、<strong>許可する</strong>にチェックを入れてから展開し直してください(<a href="troubleshooting.html#install">困ったときは</a>)。</p>
49+
</div>
2450

25-
開発・動作確認用は、リポジトリのルートで次を実行します。
51+
### Docker
2652

2753
```bash
28-
dotnet run --project src/MesApp.Api
54+
docker run -d -p 8080:8080 -v mesapp-data:/data ghcr.io/msmsrep/parallelfactorymes
2955
```
3056

31-
既定では `http://localhost:5288` で起動します。ポートを変えたい場合は次のようにします。
57+
ブラウザで `http://localhost:8080` を開きます。`-v mesapp-data:/data` を付けないと、コンテナを作り直したときにデータが消えます。
58+
PostgreSQL と一緒に動かす場合は[管理者向け運用](operations.html#docker)を参照してください。
59+
60+
### ソースから動かす(開発用)
61+
62+
.NET 10 SDK を入れ、リポジトリのルートで次を実行します。既定では `http://localhost:5288` で起動します。
3263

3364
```bash
34-
dotnet run --project src/MesApp.Api --urls http://localhost:5210
65+
dotnet run --project src/MesApp.Api
3566
```
3667

37-
複数PCで使う本番相当の配置手順は[管理者向け運用](operations.html)を参照してください。
68+
同じLAN内の他のPCから使う場合の設定(ポート・ファイアウォール・HTTPS)は[管理者向け運用](operations.html)を参照してください。
3869

3970
<div class="note">
40-
<p>データベースファイルと署名鍵は<strong>データ保存先</strong>(既定 <code>%LOCALAPPDATA%\ParallelFactoryMES</code>)に自動生成されます。データベースの作成作業は不要です。</p>
71+
<p>データベースファイルと署名鍵は<strong>データ保存先</strong>に自動生成されます。データベースの作成作業は不要です。
72+
保存先は既定で <code>%LOCALAPPDATA%\ParallelFactoryMES</code>(Linux は <code>~/.local/share/ParallelFactoryMES</code>、Docker は <code>/data</code>)です。</p>
4173
</div>
4274

4375
## 初期管理者アカウントを作る
@@ -98,3 +130,8 @@ dotnet run --project src/MesApp.Api --urls http://localhost:5210
98130

99131
業務を始めるにはマスタ登録が必要です。特に **工程 → 品目 → 工順(BOP)** の順で登録しないと
100132
製造指図を工程展開できません。[マスタ管理](masters.html)へ進んでください。
133+
134+
まず動きを試したい場合は、サンプルデータを入れると製造指図から出荷まで操作できる状態になります。
135+
[マスタのサンプル](https://github.com/msmsrep/ParallelFactoryMES/releases/latest/download/samples-master-csv.zip)を
136+
**マスタ管理**の「ZIPで一括取込」で、続けて[実績のサンプル](https://github.com/msmsrep/ParallelFactoryMES/releases/latest/download/samples-actual-csv.zip)を
137+
**管理 → 実績CSV取込**の「ZIPで一括取込」で取り込みます([マスタ管理のCSV](masters.html#csv))。

‎docs/index.md‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,7 @@ next_title: 導入と初期設定
6161
| 出荷 | 出荷管理 | 物流・倉庫 | [物流・在庫管理](logistics.html) |
6262
| 設備・治工具 | 設備保全/治工具管理 | 設備保全 | [設備保全・治工具](maintenance.html) |
6363

64-
## このバージョンでできること・できないこと
65-
66-
**利用できます**
64+
## このバージョンでできること
6765

6866
- 生産管理(製造指図・工程展開・進捗)
6967
- 製造実行(差立・段取り・チェックリスト・実績・トラブル報告)
@@ -73,10 +71,7 @@ next_title: 導入と初期設定
7371
- 設備保全(稼働記録・保全計画/指示/実績・手順書)と治工具寿命管理
7472
- 帳票・ラベル出力、バーコード/QRスキャン
7573
- データベースは SQLite(既定)・PostgreSQL・SQL Server から選択
76-
77-
**まだ利用できません**
78-
79-
- Docker イメージ・Zip パッケージでの配布
74+
- 配布は Microsoft Store 版(1台で試す)・ZIP(Windows / Linux)・Docker の3通り([導入と初期設定](getting-started.html))
8075

8176
<div class="note">
8277
<p><strong>用語やステータスの意味を調べたいとき</strong>は<a href="reference.html">リファレンス</a>を、

0 commit comments

Comments
 (0)