Requirements

動作環境・前提条件

導入前に確認すべきサーバー環境、FAX受信環境、APIキー取得について説明します。

構成の概要

Yokinsoft Paperlessは、自社サーバーにインストールして運用するオンプレミス型のシステムです。クラウドサービスへの登録は不要ですが、AI分類にGoogle Gemini APIを使用するためインターネット接続が必要です。

社内 PC / スマートフォン
ブラウザ
⟵ LAN ⟶
自社サーバー
Node.js + Python
SQLite
⟶ インターネット
AI解析のみ
Google Gemini
API
⚠️

注意:文書はAI解析時にGoogle Gemini APIへ一時的に送信されます。解析完了後のデータは自社サーバーのSQLiteデータベースにのみ保管されます。社内規定に照らして利用可否をご確認ください。

サーバー動作環境

本システムはLinuxおよびWindowsの両環境で動作します。いずれのOSでも、Python・Node.jsが動作する環境であれば稼働可能です。

項目要件
OS Linux(Ubuntu 20.04 LTS 以降推奨) 推奨
Windows 10 / 11 または Windows Server 2019 以降 対応
Linux・Windows ともに動作確認済みです。サービス常駐にはLinuxのsystemdまたはWindowsのサービス登録を使用します
Python 3.10 以上 必須
ファイル監視 (monitor) および DB初期化スクリプトで使用
Node.js 18.x 以上 必須
WebアプリケーションサーバーおよびAPIサーバーで使用
データベース SQLite(追加インストール不要) 自動
better-sqlite3 経由でNode.jsから使用。外部DBサーバー不要
ディスク空き容量 FAX受信量に応じて確保 推奨
A4 FAX 1枚あたりおよそ100〜300KB。月1,000件受信で約300MB/月を目安にしてください
メモリ 2GB 以上推奨 推奨
Node.js + Python が常時稼働するため最低1GB、2GB以上を推奨します
ネットワーク 社内LAN接続 + インターネット接続 必須
ブラウザからのアクセスに社内LAN、AI解析のためインターネット接続が必要
ポート デフォルト 3000(設定変更可) 変更可
社内ファイアウォールでサーバー:ポートへのアクセスを許可してください

FAX受信環境の前提条件

本システムはFAX受信そのものは行いません。既存のFAX機器・サーバーが受信したファイルをフォルダに保存する機能を利用して連携します。

項目要件
FAX機器・サーバー IP-FAXサーバー または FAXサーバーソフトウェア 必須
受信したFAXをファイルとして保存できるものが必要です
保存形式 PDF または TIFF 必須
受信FAXをPDFもしくはTIFF形式でサーバー上のフォルダに保存する設定が必要です
保存先フォルダ Paperlessサーバーからアクセス可能なローカルパス 必須
Pythonモニター(watchdog)がフォルダを監視します。マウント方式によって動作の安定性が異なります:
  • ローカルフォルダ:最も安定。OS問わず推奨
  • Windows ファイル共有(SMB)マウント:安定して動作します
  • Samba マウント(Linux から SMB):マウントオプション(notify_flags等)の設定が必要な場合があります
  • NFS マウント:watchdog によるファイル作成イベントが通知されないため動作しません
FAXファイル用ファイルサーバーと同一ホストにmonitorをインストールし、ローカルフォルダを直接監視する構成が最も安定します。Linux・Windows いずれの場合も、監視対象フォルダと同じマシンにmonitorを配置することを推奨します。
保存ファイル名の規則 日時・送信者情報を含む形式を推奨 推奨
ファイル名から受信日時・送信元番号を取得できる場合は自動抽出されます。取得できない場合はAI解析で補完されます
ℹ️

確認のポイント:既存のFAXサーバーが「受信ファイルをフォルダに自動保存できるか」が導入の前提です。FAXサーバーの管理者にご確認ください。

Google Gemini APIキーの取得

文書のAI自動分類にはGoogle Gemini APIを使用します。APIキーの取得と設定が必要です。

🔴

重要:AI分類機能を使用する場合、受信したFAX文書の画像がGoogle Gemini APIに送信されます。社外秘・機密情報を含む文書が含まれる可能性がある場合は、社内ポリシーや情報セキュリティ規程を必ず確認した上で導入を判断してください。


APIキー取得の手順

項目内容
使用APIサービス Google Gemini API(生成AI)
無償枠 Gemini 1.5 Flash:1日あたり一定リクエスト数まで無償
無償枠の上限はGoogleの方針により変更されることがあります
送信データ FAX受信ファイル(PDF/TIFF 1件ずつ)の画像データ
データの取り扱い Googleの利用規約・プライバシーポリシーに準じます
Google Gemini API利用規約
インターネット接続 サーバーからGoogleのAPIエンドポイントへのアウトバウンドHTTPS通信が必要

導入前チェックリスト

導入を検討する際に確認しておくべき事項をまとめました。

技術環境

FAX受信環境

セキュリティ・情報管理

セットアップの大まかな流れ

詳細な手順は同梱の INSTALL_WEB.md および INSTALL_MONITOR.md を参照してください。ここでは流れの概要を示します。

インストールに必要なスキル

自社のIT担当者やエンジニアが導入する場合のスキル目安をまとめました。プログラミング知識は不要です。定型的なIT担当者レベルで対応できる範囲です。→ Yokinsoftの有償導入支援も選択できます

基礎

コマンドライン操作

ターミナル(PowerShell / bash)でのディレクトリ移動・コマンド実行ができること。例:cdpip installnpm install

基礎

Python実行環境の準備

監視モジュール(monitor)に使用。Python(3.10以上)のインストールと仕想環境(venv)の作成・有効化ができること。公式インストーラーを使えれば大丈夫です。

基礎

Node.js実行環境の準備

Webインターフェース(web)に使用。Node.js(v18以上)のインストールとnpm installによるパッケージ取得ができること。

基礎

テキストファイルの編集

設定ファイル(.env)をメモ帳・VSCode等で開き、APIキーやフォルダパスを書き換えられること。

基礎

Googleアカウント操作

Google AI StudioにGemini APIキーを発行できること(無料枠あり)。ブラウザ操作のみで完結します。

やや応用

Git / GitHubの基本操作

リポジトリのクローン(git clone)ができること。GUIツール(GitHub Desktop等)でも代替可能です。

やや応用

ネットワーク・サーバー基礎

社内ネットワーク内でのポート開放やファイアウォール設定の確認ができると、Webインターフェースの公開がスムーズです。

ℹ️

プログラミング知識は不要です。各ステップはドキュメントの手順に沿って進めるだけで完了します。監視モジュールのカスタマイズ(分類ルール変更等)にはPythonの基礎知識、WebUIのカスタマイズにはNode.js / TypeScriptの基礎知識があると対応しやすくなります。