Skip to content

Commit 0d3fbfe

Browse files
committed
#65 : Fixed errors in readme
1 parent d20017c commit 0d3fbfe

2 files changed

Lines changed: 16 additions & 13 deletions

File tree

doc/readme/ReadmeENG.html

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h1>2. System requirements</h1>
4949

5050
<ul><li>Memory:1 GB or more</li></ul>
5151

52-
<ul><li>Free disk space: 20 MB or more</li></ul>
52+
<ul><li>Free disk space: 40 MB or more</li></ul>
5353

5454
<ul><li>Operating systems/editions supported:<br/>
5555
Windows 11<br/>
@@ -178,7 +178,7 @@ <h1>6. Uninstallation</h1>
178178
<li>Auto stop of CmdFreak service and Web server(nginx).</li>
179179
<li>Unregister exceptions of firewall for CmdFreak.</li>
180180
<li>Remove the service of CmdFreak from the target system.</li>
181-
<li>Starts Web server</li>
181+
<li>Starts the Web server</li>
182182
</ul>
183183
If an existing nginx instance is already in operation, restarting nginx may affect active sites.<br>
184184
During uninstallation, the SELinux configuration (httpd_can_network_connect) is not reverted to pre-installation status.
@@ -203,7 +203,8 @@ <h1>7. Login to CmdFreak</h1>
203203
If main console is not appeared or an error occurred, confirm the things shown below.<br/>
204204
<ul>
205205
<li>When host name is specified in the URL for the connection to CmdFreak from browser, confirm that the host name can be resolved. In case the host name is not resolved, change the host name to another name that can be resolved, and then retry.</li>
206-
<li>Confirm that CmdFreak(nginx.exe) is registered as an exception of Windows firewall. If not, register nginx.exe to the Windows firewall as an exception. </li>
206+
<li>Confirm that the Web server (nginx) process or port number is registered as a firewall exception.
207+
If not, register the process or port number as a firewall exception. </li>
207208
<li>Confirm that the specified port number is not already in use by another process. If it is, choose a different port number as described below.</li>
208209
</ul>
209210

@@ -239,15 +240,17 @@ <h1>9. Change IP address/host name and port number</h1>
239240
Change IP address/host name and port number.<br/>
240241
<p>
241242
<u>In case you change IP address/host name and port number which CmdFreak service uses:</u><br/>
242-
Specify IP address/host name and port number to servicehost and serviceport properties in &lt;Installation folder&gt;\cmdfreak.conf<br/>
243-
Specify IP address/host name and port number to proxy_pass of location /api/ section in &lt;Installation folder&gt;\conf\nginx.conf<br/>
243+
Specify IP address/host name and port number to servicehost and serviceport properties in &lt;Installation folder&gt;\cmdfreak.conf (for Windows)
244+
or /etc/cmdfreak.conf (for Linux)<br/>
245+
Specify IP address/host name and port number to proxy_pass of location /api/ section in &lt;Installation folder&gt;\conf\nginx.conf (for Windows)
246+
or /etc/nginx/conf.d/cmdfreak_nginx.conf (for Linux)<br/>
244247
</p>
245248
<p>
246249
<u>In case you change IP address/host name and port number which Web server uses:</u><br/>
247-
Change listen and server_name in &lt;Installation folder&gt;\conf\nginx.conf<br/>
250+
Change listen and server_name in &lt;Installation folder&gt;\conf\nginx.conf (for Windows) or /etc/nginx/conf.d/cmdfreak_nginx.conf (for Linux)<br/>
248251
</p>
249252
</li>
250-
<li>Change firewall setting if necessary.</li>
253+
<li>Change firewall setting if necessary. If SELinux is enabled, add access permission to the target port using "semanage port" command.</li>
251254
<li>Start CmdFreak service.</li>
252255
</ol>
253256

doc/readme/ReadmeJPN.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ <h1>2. システム要件</h1>
5454

5555
<ul><li>動作に必要なメモリ容量: 1GBytes以上</li></ul>
5656

57-
<ul><li>導入に必要な空きディスク容量: 20MBytes以上</li></ul>
57+
<ul><li>導入に必要な空きディスク容量: 40MBytes以上</li></ul>
5858

5959
<ul><li>サポートするオペレーティングシステム/エディション:<br/>
6060
Windows 11<br/>
@@ -204,7 +204,7 @@ <h1>7. CmdFreakへのログイン方法</h1>
204204
メインコンソールが表示されない場合,またはエラーが表示される場合下記を確認してください。<br/>
205205
<ul>
206206
<li>ブラウザからCmdFreakへの接続でURLにホスト名を指定している場合,ホスト名からIPアドレスが名前解決できること。 名前解決できない場合,名前解決可能なホストに変更し,再度接続を試みてください。</li>
207-
<li>CmdFreak(nginx.exe)がWindowsのファイアウォールに例外登録されていること。 例外登録されていない場合,nginx.exe をファイアウォールの例外に登録してください</li>
207+
<li>Webサーバ(nginx)のプロセスまたはポート番号がファイアウォールに例外登録されていること。 例外登録されていない場合,プロセスまたはポート番号をファイアウォールの例外に登録してください</li>
208208
<li>WebサーバおよびCmdFreakサービスが使用するポート番号が他のプロセスが使用するポート番号と重なっていないこと。 後述のポート番号の変更手順に従い,ポート番号が重ならないよう変更を行ってください。</li>
209209
</ul>
210210

@@ -240,15 +240,15 @@ <h1>9. IPアドレス/ホスト名およびポート番号の変更</h1>
240240
IPアドレスおよびポート番号を変更します。<br/>
241241
<p>
242242
<u>CmdFreakサービスが使用するIPアドレスおよびポート番号を変更する場合:</u><br/>
243-
<インストール先フォルダ>\cmdfreak.conf のservicehostおよびserviceport プロパティにCmdFreakサービスのIPアドレスおよびポート番号を設定します<br/>
244-
<インストール先フォルダ>\conf\nginx.conf のlocation /api/ セクションのproxy_pass にCmdFreakサービスのIPアドレスおよびポート番号を設定します<br/>
243+
<インストール先フォルダ>\cmdfreak.conf (Windows版)または/etc/cmdfreak.conf (Linux版) のservicehostおよびserviceport プロパティにCmdFreakサービスのIPアドレス/ホスト名およびポート番号を設定します<br/>
244+
<インストール先フォルダ>\conf\nginx.conf (Windows版)または/etc/nginx/conf.d/cmdfreak_nginx.conf (Linux版) のlocation /api/ セクションのproxy_pass にCmdFreakサービスのIPアドレス/ホスト名およびポート番号を設定します<br/>
245245
</p>
246246
<p>
247247
<u>Webサーバが使用するIPアドレスおよびポート番号を変更する場合:</u><br/>
248-
<インストール先フォルダ>\conf\nginx.conf のlistenおよびserver_name を変更します。<br/>
248+
<インストール先フォルダ>\conf\nginx.conf (Windows版)または/etc/nginx/conf.d/cmdfreak_nginx.conf (Linux版) のlistenおよびserver_name を変更します。<br/>
249249
</p>
250250
</li>
251-
<li>必要に応じてファイアウォールの設定を変更します。</li>
251+
<li>必要に応じてファイアウォールの設定を変更します。SELinuxが有効なときは、"semanage port"コマンドで対象のポートに対してアクセス許可を与えます。</li>
252252
<li>CmdFreakサービスを起動します。</li>
253253
</ol>
254254

0 commit comments

Comments
 (0)