WebtoB Administrator's Guide

WebtoB 5 Fix#2

Restricted Rights Legend

All TmaxSoft Software (Tmax®) and documents are protected by copyright laws and international convention. TmaxSoft software and documents are made available under the terms of the TmaxSoft License Agreement and may only be used or copied in accordance with the terms of this agreement. No part of this document may be transmitted, copied, deployed, or reproduced in any form or by any means, electronic, mechanical, or optical, without the prior written consent of TmaxSoft Co., Ltd.

Nothing in this software document and agreement constitutes a transfer of intellectual property rights regardless of whether or not such rights are registered) or any rights to TmaxSoft trademarks, logos, or any other brand features.

This document is for information purposes only. The company assumes no direct or indirect responsibilities for the contents of this document, and does not guarantee that the information contained in this document satisfies certain legal or commercial conditions.

The information contained in this document is subject to change without prior notice due to product upgrades or updates. The company assumes no liability for any errors in this document.

Trademarks

Tmax WebtoB® is registered trademark of TmaxSoft Co., Ltd. Other products, titles or services may be registered trademarks of their respective companies.

Open Source Software Notice

Some modules or files of this product are subject to the terms of the following licenses: OpenSSL, ZLIB, PCRE, APACHE1.0, APACHE1.1, APACHE2.0, JSON-C, BSD, RSA, PHP, Paul Hsieh's hash

Detailed Information related to the license can be found in the following directory : ${INSTALL_PATH}/lib/licenses

Document Information

Document Name: WebtoB Administrator's Guide

Document Created: 2018-08-24

Software Version: WebtoB 5 Fix#2

Document Version: v2.1.3


Table of Contents

About This Document
1. Introduction
1.1. Structure and Operation
1.1.1. Comparison with Conventional Web Servers
1.1.2. WebtoB Processes and Threads
1.2. Features
1.2.1. Caching
1.2.2. WBAPI
1.2.3. Calling TP-Monitor Tmax Service
1.2.4. Extension Management
1.2.5. Logging
1.3. Management Tool
1.4. Environment Variables
1.5. Directory Structure
1.6. License Specific Functions
2. Quick Start
3. Environment Configuration
3.1. Overview
3.1.1. Configuration File Structure
3.1.2. Configuration File Compilation
3.1.3. Configuration Item Description Rules
3.2. DOMAIN Section
3.2.1. Configuration Items
3.2.2. Example
3.3. NODE Section
3.3.1. Configuration Items
3.3.2. Example
3.4. VHOST Section
3.4.1. Configuration Items
3.4.2. Example
3.5. HTH_THREAD Section
3.5.1. Configuration Items
3.5.2. Example
3.6. SVRGROUP Section
3.6.1. Configuration Items
3.6.2. Example
3.7. SERVER Section
3.7.1. Configuration Items
3.7.2. Example
3.8. SERVICE Section
3.8.1. Configuration Items
3.8.2. Example
3.9. DIRECTORY Section
3.9.1. Configuration Items
3.9.2. Example
3.10. URI Section
3.10.1. Configuration Items
3.10.2. Example
3.11. ALIAS Section
3.11.1. Configuration Items
3.11.2. Example
3.12. DIRINDEX Section
3.12.1. Configuration Items
3.12.2. Example
3.13. LOGGING Section
3.13.1. Configuration Items
3.13.2. Example
3.14. ACCESS Section
3.14.1. Configuration Items
3.14.2. Example
3.15. AUTHENT Section
3.15.1. Configuration Items
3.15.2. Example
3.16. EXT Section
3.16.1. Configuration Items
3.16.2. MIME-Type
3.16.3. Example
3.17. SSL Section
3.17.1. Configuration Items
3.17.2. CA Command
3.17.3. Example
3.18. PROXY_SSL Section
3.18.1. Configuration Items
3.18.2. Example
3.19. ERRORDOCUMENT Section
3.19.1. Configuration Items
3.19.2. Example
3.20. EXPIRES Section
3.20.1. Configuration Items
3.20.2. Example
3.21. TCPGW Section
3.21.1. Configuration Items
3.21.2. Example
3.22. REVERSE_PROXY_GROUP Section
3.22.1. Configuration Items
3.22.2. Example
3.23. REVERSE_PROXY Section
3.23.1. Configuration Items
3.23.2. Example
3.24. LOGLEVEL Section
3.24.1. Configuration Items
3.24.2. Example
3.25. HEADERS Section
3.25.1. Configuration Items
3.26. PRECEDING_COMMAND Section
3.26.1. Configuration Items
3.26.2. Example
3.27. FILTER Section
3.27.1. Configuration Items
3.27.2. Example
3.28. USERLOGFORMAT Section
3.28.1. Configuration Items
3.28.2. Example
3.29. DISK_CACHE Section
3.29.1. Configuration Items
3.29.2. Example
4. Advanced Configuration
4.1. Dynamic Content
4.1.1. CGI
4.1.2. SSI
4.1.3. PHP
4.2. Virtual Hosting
4.2.1. Virtual Host Structure
4.2.2. Mass Virtual Host
4.3. Log
4.3.1. Log File
4.3.2. Log Format
4.3.3. Common Log Format
4.3.4. Environment Configuration
4.4. Integration with Tmax
4.4.1. Tmax Integration Configuration
4.4.2. Usage Example
4.5. Integration with JEUS
4.5.1. WebtoB and JEUS 6 Integration Method
4.5.2. JEUS 6 Integration Configuration (Standard+)
4.5.3. Using Embedded Servlet Engine for Enterprise (JEUS 7)
4.6. Connecting to Other Web Application Servers
4.6.1. Using Reverse Proxy
4.6.2. Connecting to Multiple Web Application Servers (Enterprise+)
4.7. URLRewrite
4.7.1. WebtoB Configuration
4.7.2. URLRewriteConfig File Configuration
4.7.3. RewriteCond
4.7.4. RewriteRule
4.7.5. Example
4.8. Filter Module Development (Enterprise+)
5. Starting Up and Shutting Down
5.1. Starting WebtoB
5.1.1. Before Starting WebtoB
5.1.2. wsboot
5.2. Shutting Down WebtoB
5.2.1. wsdown
6. WebtoB Administration
6.1. wsadmin Console Management Program
6.1.1. Environment Configuration
6.1.2. Active State Information
6.1.3. Suspend and Resume Server Processes
6.1.4. Queue Purge
6.1.5. Dynamic Configuration Change
6.1.6. Client Disconnection
6.1.7. Other
6.2. wsmon Console Monitoring Program
6.3. Commands
6.3.1. wscfl
6.3.2. wsuncfl
6.3.3. wsgst
6.3.4. wsracd
6.3.5. wsmkppd
7. WebtoB Tuning
7.1. HTH and HTH_THREAD Configuration
7.1.1. HTH
7.1.2. HTH Thread
7.1.3. Example
7.2. Server Process Configuration
7.2.1. Example
7.3. Tuning Configuration for BRUN
7.3.1. HttpOutBufSize and FlowControl
7.3.2. How to Reduce BRUNs
8. WebtoB Security
8.1. Authentication Method
8.2. SSL
8.2.1. SSL v3.0
8.2.2. SSL vs. SHTTP
8.2.3. SSL Encryption
8.2.4. Ciphers
8.3. Certificate Service
8.3.1. Certificate Authority
8.3.2. Certificate
8.3.3. Certificate Issuing Policy
8.3.4. Receiving a Server Certificate from Verisign
8.4. Using Authentication and SSL
8.4.1. Authentication
8.4.2. Configuring SSL
9. WBAPI
9.1. Overview
9.2. Concept
9.3. Environment Configuration
9.4. Service Table Creation
9.5. Program Compilation
9.6. Starting and Using WBAPI
9.7. WBAPI Types
9.7.1. INIT/DONE API
9.7.2. ALLOC API
9.7.3. GET API
9.7.4. PUT/SET API
9.7.5. SEND API
9.7.6. COOKIE API
9.7.7. SESSION API
9.7.8. ETC API
9.8. CGI Conversion Using WBAPI
9.8.1. CGI Program
9.8.2. WBAPI Program
A. Environment Configuration Example
A.1. Basic Configuration
A.2. WebtoB and JEUS Integration Configuration
A.2.1. JEUS 6 Integration Configuration
A.2.2. Embedded Servlet Engine Integration Configuration (JEUS 7)
B. CGI Application Example
B.1. Overview
B.2. Implementing BBS in C
B.2.1. Environment File
B.2.2. HTML Page
B.2.3. CGI Source Code
B.2.4. Configuration and Checking the Results
B.3. Implementing BBS in Pearl
B.3.1. Environment File
B.3.2. Perl Script
B.3.3. Configuration and Checking the Results
C. Integration with Tmax
C.1. Client Program for Integrating with Tmax
C.2. Compiling Client Program
C.3. Integrating with Tmax
Index

List of Figures

[Figure 2.1] WebtoB Test Page
[Figure 4.1] PHP Test Page
[Figure 4.2] Virtual Host Structure
[Figure 4.3] Regex Back-Reference
[Figure 9.1] CGI Operation in Apache
[Figure 9.2] WBAPI in WebtoB
[Figure B.1] Screen shot of C based Bulletin Board System
[Figure B.2] Article Posted on C based BBS
[Figure B.3] Input Form of Perl based BBS
[Figure B.4] Result Screen of Perl based BBS.
[Figure C.1] toupper.html
[Figure C.2] TOUPPER Result Screen