こんにちは。株式会社インプリムのhmineです。
ふだんはOSSのノーコード・ローコード開発ツール「プリザンター」に新機能を追加をしています。
プリザンターの活用事例やYouTube等をご覧いただき、興味が芽生えてきたみなさま。
以下プリザンターの公式マニュアルは、ご覧いただけましたか?
🔗Pleasanter ユーザーマニュアル | OSSのローコード開発プラットフォーム
> ユーザマニュアル > セットアップ手順
2024年、プリザンターをセットアップする公式の手順がどーん!と増量されました!
やりたいこと別にマニュアルを整理してみたいと思います。
〈目次〉
※なお、公式マニュアル更新のたびに毎回記事をメンテナンスするのは難しいため、あくまで【2024年末時点】のラインナップで整理した結果である旨をご承知おきください。
🎁Advent Calendar完走まであと僅か!🎁
OSSのノーコード・ローコード開発ツール「プリザンター」 Advent Calendar 2024 にたくさんの記事を投稿いただき、ありがとうございます!
それぞれの記事への「いいね」もお待ちしています!
❔見たことがないインストール手順❔
「Google Chrome」や「サクラエディタ」といったソフトウェアや、Microsoft Storeで配布されているWindowsアプリケーションとは異なり、DB、.NET、Webサーバの設定、コマンドプロンプトなど、IT技術要素が剥き出しで見えているのが今のプリザンターです。 ただし、IT業界外の方を排除する意図はまったくありません🙇♀️
ここで、番外編として「お手軽度 圧倒的No.1」のプリザンターをご紹介します。
👉60日間の利用制限はありますが、インターネット上の「プリザンターのデモ」をご使用ください。その次のステップとして、マニュアルに書かれているセットアップ手順へ進んでいただけますと嬉しいです!
公式マニュアルラインナップのチェック
1. 目的別おすすめインストール手順
1. はじめてプリザンターの機能を確認するおすすめ手順
はじめてであれば、お手元のクライアントPC(Windows11等)にインストールいただき、ひとりだけで使うプリザンターを構築してみるのがお勧めです。
※Macユーザ様はDockerで立ち上げてみてください。
※Windows10 / 11をご使用の場合、「プリザンターをWindowsにインストールする」を先にご覧ください。
※Macユーザ様はDockerで立ち上げてみてください。
❔データベースの選択肢❔
- SQL Server
- PostgreSQL
- MySQL
どれか一つを選ぶようにマニュアルに記載があるが、どれを選択すればいいかわからない場合は、Implem.Pleasanter/App_Data/Parameters/Rds.json をメモ帳等で実際に開き、既定値と同じものを選んでください。
"Dbms": "PostgreSQL" という既定値が書かれていれば、その既定値のまま、つまりPostgreSQLを使用する手順に進んでください。
❔プリザンターのインストーラを使う❔
プリザンターの公式インストーラが2024年12月にリリースされました!🎊🎊🎊
インストーラはオンプレミス環境で使用し、コマンドから起動します。
初期セットアップだけでなく、バージョンアップ時のモジュールダウンロード~現行プリザンターにある設定の転記作業が自動になるのがインストーラの良いところ。
開発チームお勧めの新ラインナップです。
なお従来手順のサポートも継続しますので、双方お試しいただいた上で、要件に合う手順をご使用ください。
リンク | 「はじめてプリザンターの機能を確認するおすすめ手順」ですか? |
---|---|
Dockerイメージを使用しDBにMySQLを指定して起動する | △ |
Dockerイメージを使用しパラメータを既定値から変更して起動する | △ |
Dockerで起動する | △ |
❔Dockerを使ってみるべきか❔
公式DockerイメージでPostgresSQLやMySQLのコンテナを立ち上げた経験があれば、Dockerのプリザンターも立ち上げられるレベル感です。(業務経験がなくても、初学者向けチュートリアルを一度でも触ってみた経験があればOKです!)
OSに.NETやデータベースがインストールされていなくても実行できるパッケージになっているのが、公式Dockerイメージ利用手順の嬉しいポイントです。
ただし、Dockerの手順はDocker Composeの事前準備が必要です(WindowsであればWSL2有効化が必要です)。
直接インストールとDockerでは、上記がトレードオフ関係になっている印象です。
Dockerは流行りの技術なのでチェックしないと…と考えているIT関係の方は、プリザンターの個人利用をネタにDockerの学習をはじめてみてもいいのでは、と思います。
2. 共用環境で運用するおすすめ手順
ひとりではなく、チームや部署でプリザンターを共用するとなった場合、お手元の個人用PCとは別の「共用のマシン」にプリザンターをセットアップします。
組織の規定に則って本格運用するならば、サーバ専用機やクラウドサービス。構築前のインフラ設計にある程度の時間を取り、規定違反がないかレビューも必要かもしれません。
身内で私的利用をするなら、余ったノートPCや個人で契約したホスティングサービス。
ホスティングサービスを借りるなら、おそらくLinux上にインストールする可能性が高いですね。Linuxコマンドの学習に不安があれば、①VirtualBoxで自分だけ練習用のサーバを立てて構築手順を練習する ②共用のマシンで実践する というプロセスを踏むと安心です。
それと、昨今はインターネットとサーバがつながっているだけで正体不明のアクセスがやってくるので、セキュリティ設定は私的利用でも要チェックですね。
このように、共用のプリザンターを構築するインフラ機器は、組織のルールや予算と見比べ、共同利用者のみなさんとよく相談しながら選択してください。
リンク | 「共用環境で運用するおすすめ手順」ですか? |
---|---|
インストーラでプリザンターをAzure AppServiceにサーバレス構成でインストールする | ○ クラウド、有償 |
インストーラでプリザンターをWindowsにインストールする | ○ 要ライセンス(有償) |
インストーラでプリザンターを Ubuntu にインストールする | ○ |
インストーラでプリザンターを AlmaLinux にインストールする | ○ |
インストーラでプリザンターを Red Hat Enterprise Linux 8 にインストールする | ○ |
インストーラでプリザンターを Red Hat Enterprise Linux 9 にインストールする | ○ |
※1 Windowsをご使用の場合、「プリザンターをWindowsにインストールする」を先にご覧ください。
※2 CentOS7は.NET8がサポート対象外となったため、プリザンターバージョン1.4.0.0以降は動作いたしません。「今日はじめてプリザンターを試したい」という場合は、CentOSを使用しないでください。(現行で運用中のシステムのために公開しているマニュアルです)
リンク | 「共用環境で運用するおすすめ手順」ですか? |
---|---|
Dockerイメージを使用しDBにMySQLを指定して起動する | ○ |
Dockerイメージを使用しパラメータを既定値から変更して起動する | ○ |
Dockerで起動する | ○ |
この後にも記載しましたが、Docker Composeのコマンドを実行できれば、どこでもプリザンターの公式Dockerイメージを使ったセットアップが可能です。
プリザンターの機能や安定性という基準では、オンプレミスとDockerに違いはありません。
特に個人利用では、「オンプレミスとDockerのどちらを使ってみたいか?」のモチベーションで方式を選んでいただければと思います。
❔SaaSでプリザンターを利用したい❔
オンプレミスで共用のサーバを組織内に立てるのがNGなルールの場合、弊社インプリムがインターネットサービスとして提供している「プリザンター.net」をちらっと見てみてください。
なお、ユーザ数や特定の機能等、お手元でCommunityEditionを使用される場合と比較して制限がありますので、確認の上で検討をお願いします。
3. [マニュアル外] 本体ソースコード改修後の動作確認をする手順
📢アプリ開発者のみなさま!
プリザンター本体はプログラミング言語「C#」で書かれています。
そしてあなたもContributorとしてプリザンターの機能追加をプルリクエストできます!
プリザンターのContributorになると、C#&プリザンター有識者とコミュニケーションする機会が増えます。
新機能を開発したいという方はぜひ、GitHubをご覧になったうえでお声がけください。
ちなみにプリザンターのソースコードからデバッグ環境を立ち上げる手順は、Qiita記事として公開されています。
プリザンターの独特なポイントを2点補足します。
1.CodeDefiner
CodeDefinerもVisual Studioから実行できます。
CodeDefinerには様々なコマンドと引数があり、それぞれ指定した際の動作を理解する必要があります。詳細は、以下マニュアルをご覧ください。
2.パラメータファイル
Qiita記事「プリザンターをVisual Studioでデバッグする」の手順に従うと、「デバッグ用」のプリザンター環境と、「実行のみ」のプリザンター環境の2つが構築されます。
開発でほしい環境は「デバッグ用」のプリザンター環境=Visual Studioの中のソリューションです。
したがって、パラメータファイル一式(Rds.json等)も2箇所に展開されますが、Visual Studioでデバッグする際に読み取られる設定はVisual Studioのソリューション配下にあるパラメータファイルの内容です。実行のみの環境「C:\web\pleasanter\…」配下のファイルは、Visual Studioからのデバッグとは無関係なのでご注意ください。
なお、ソリューションの配下にあるパラメータファイルを書き換えた際は、Visual Studio上でプリザンターのデバッグを再起動してください。
2. インストール先で分類する
1. 現在操作しているWindows11等に直接インストールする手順
ふだんインターネットのサイトやサービスを閲覧したり、書類を執筆したりしている「ふつうのPC」(クライアントPC)にプリザンターをインストールします。
はじめてプリザンターの機能を確認する際のおすすめ手順です。
※Windows10 / 11をご使用の場合、「プリザンターをWindowsにインストールする」を先にご覧ください。
リンク | 「現在操作しているWindows11等に直接インストールする手順」ですか? |
---|---|
Dockerイメージを使用しDBにMySQLを指定して起動する | × |
Dockerイメージを使用しパラメータを既定値から変更して起動する | × |
Dockerで起動する | × |
❔Dockerの位置づけ❔
Dockerは「現在操作しているWindows11等に直接インストールする手順」であるかが微妙な判断ですが、Windows11の場合はWSL2を有効化してLinux上で運用するため、ここは「×」で統一しました。
2. [マニュアル外] Macでプリザンターをセットアップする手順
公式マニュアルでクライアントに直接インストールする手順について、Windows系統のマニュアルのみ公開されていますが(🙇♀️)、プリザンターはMacユーザ様も歓迎しています!
Macユーザ様の場合、OSを問わない公式Dockerイメージのご利用を強くお勧めします。
なお、以下記事(by 2019年アドベントカレンダー)ではプリザンターのバージョンが過去のものになるため、最新バージョンへの読み替えが必要です。
ここでお伝えしたいことは後述のリストの通りです。
〈オンプレミスのセットアップ(※1)に共通で必要なこと〉
- .NET実行環境が必要 - 2024年の現行版=プリザンターの1.4.x.x系統では.NET8
- Webサーバが必要(※2)
- SQL Server/PostgreSQL/MySQLいずれかのデータベースが必要(※2)
※1 2024年現在、OSを問わない公式Dockerイメージのご利用を強くお勧めします。
※2 2019年の記事ではnginxとSQL ServerをDockerのサービスとして立ち上げています。
3. 仮想OSにインストールする手順
業務システム環境でおなじみの、仮想OSにオンプレミスでセットアップする手順です。
お手元のWindows11等をホストとして以下手順でセットアップする場合は、あらかじめ、Oracle Virtual Box、VMware製品、Hyper-V等の仮想環境用ソフトウェアと、各OSのインストールイメージを使用し、WindowsやLinuxのゲストマシンを立ち上げてください。
※Windows Serverの運用には有償のライセンスが必要です。
※1 Windowsをご使用の場合、「プリザンターをWindowsにインストールする」を先にご覧ください。
※2 Windows10 / 11は業務システム用のサーバに採用されることは少ないと思いますが、たとえば仮想デスクトップ用のWindows10 / 11でプリザンターはセットアップ可能です。
※3 CentOS7は.NET8がサポート対象外となったため、プリザンターバージョン1.4.0.0以降は動作いたしません。「今日はじめてプリザンターを試したい」という場合は、CentOSを使用しないでください。(現行で運用中のシステムのために公開しているマニュアルです)
リンク | 「仮想OSにインストールする手順」ですか? |
---|---|
Dockerイメージを使用しDBにMySQLを指定して起動する | × |
Dockerイメージを使用しパラメータを既定値から変更して起動する | × |
Dockerで起動する | × |
❔Dockerの位置づけ❔
仮想のWindows ServerやLinuxにDocker Composeをインストールし、公式Dockerイメージを使用してコンテナを構築することは可能です。ただしそれは、ここで意図していた「オンプレミスの手順」ではないため、上表で「×」扱いとしました。
4. コンテナで構築する手順
場所を問わずDocker Composeを使用し、コンテナでプリザンターを立ち上げる手順です。
公式DockerイメージでPostgresSQLやMySQLのコンテナを立ち上げた経験があれば、Dockerのプリザンターも立ち上げられるレベル感です。(業務経験がなくても、初学者向けチュートリアルを一度でも触ってみた経験があればOKです!)
リンク | 「コンテナで構築する手順」ですか? |
---|---|
Dockerイメージを使用しDBにMySQLを指定して起動する | ○ |
Dockerイメージを使用しパラメータを既定値から変更して起動する | ○ |
Dockerで起動する | ○ |
❔Dockerの位置づけ❔
この項の冒頭で「場所を問わず」と書いた通り、Docker Composeのコマンドを実行できればどこでもコンテナで運用可能です。
- Windows11やMac等のクライアントPC
- もちろんクライアントPC上のOSがLinuxだという場合もOK
- 仮想環境上のWindows ServerやLinuxサーバ
- AzureやAWS等のクラウドサービス内のコンピューティングサービス(OSとしてWindows ServerやLinuxを使用する)
プリザンターの公式マニュアルでは「はじめてプリザンターの機能を確認する利用者」を想定したDocker用マニュアルのラインナップが揃っています。
👉公式マニュアルを読んだ皆さまの知見を生かし、最適なシステム構成を作っていただければと思っています。
(そして可能な範囲で事例を記事として公開いただけると嬉しいです。)
3. 公式プリザンター配布元のご紹介
最後に、プリザンターの公式の配布元をご紹介します。
上記以外で、認定パートナー様が開発されたプリザンター関連資源(補助ツールを含む)、完全な非公式のプリザンター関連資源があります。
配布資源の公開元をよく確認された上でプリザンターをご使用ください。
特に、はじめてプリザンターをインストールされる場合、まずは公式の配布元からご入手を検討いただけると嬉しいです!
❔ダウンロードセンターでメールアドレスを登録して大丈夫ですか❔
ダウンロードセンターでメールアドレスを登録いただくと、「プリザンター活用支援チーム」から自動送信メールが届くようになります。
登録後すぐに「プリザンターのダウンロードセンターのURL」をお届けします。
セットアップする際必ず確認いただきたいメールはこの1通です。
その後、ときどき「プリザンター活用支援チーム」から宣伝が届くようになりますが、メールアドレス以外の個人情報を収集することはありません。これらの自動送信メールアドレス宛にご返信をいただく必要はありません。
※「プリザンター活用支援チーム」による自動送信メールの仕様は「プリザンターのデモ」のご利用についても同じです。