安装维护手册 - 示例
XXX 项目 用 户 手 册 XXX 有限公司 年 月编制 用户手册 目 录 第第 1 章章引言引言.1 1.1 编写目的.1 1.2 软件背景.1 第第 2 章章ORACLE 数据库安装数据库安装 .2 2.1 前期准备.2 2.2 安装流程.3 第第 3 章章项目应用部署项目应用部署.10 3.1 WEB应用程序发布.10 3.1.1 JDK 的安装.10 3.1.2 Tomcat 的安装.12 3.1.3 Web 应用程序部署 .12 3.2 数据库部署.13 3.3 系统部署信息汇总.14 第第 4 章章系统管理员平台维护系统管理员平台维护.15 4.1 数据字典.15 用户手册 第 1 页 共 15 页 第 1 章引言 1.1 编写目的 为了让 XXXX 管理软件的最终用户对系统有更加完整的了解，现将系统所 需要的运行环境、部署情况及安全性设置做一个详细说明。 该文档主要面向这套软件的管理者和维护者。本文详细的描述了软件安装 的硬件环境、软件环境和安装部署情况。用户可以根据这些信息对系统进行必 要的操作，维护系统、升级系统，保证系统安全、稳定、高效的运行。 1.2 软件背景 为了更好的管理和 XXX 公司的项目，使管理规范化，提高工作效率，使 项目中的成员及时沟通，在 XXX 公司 XXXX 处提出大量需求的情况下，XXX 公司根据提出的需求，开发出了 XXX 公司 XXX 软件系统。该系统面上公司所 管辖的项目，系统安装在 XXX 公司调度中心的机房。 用户手册 第 2 页 共 15 页 第 2 章项目应用部署 2.1 Web 应用程序发布 当前企业级软件编写基本都是用 java 语言来完成，本系统也是是用 java 语 言来完成的。由于 java 语言的高可移植性和跨平台能力，从而使得了应用程序 能够“一次编译，处处运行”。 应用程序运行需要一个基本的运行环境，也就是说需要 JDK 和 web 容器的 支持。下面就来介绍如何构建这样一个系统发布的平台。 2.1.1 JDK 的安装的安装 首先，根据应用的要求、操作系统的种类和硬件结构选择对应的 JDK 安装 程序。在选择完成后，进入下面的安装过程。 1）在 Linux 下安装过程非常简单，将需要安装的 JDK 软件包拷贝到目标 路径下运行即可。 root GDGS # ./jdk-6u21-linux-x64.bin 运行完成后就完成了 JDK 的安装。 2）在 windows 下安装过程同样非常简单。 第第 1 步步：找到下载的 JDK 安装包，双击后弹出安装准备界面。 第第 2 步步：在安装准备界面完成后，出现下图所示的安装路径配置界面。配 置完成相应的安装路径和安装模块后，单击“下一步”进入下一个安装界面。 用户手册 第 3 页 共 15 页 第第 3 步步：开始安装 JDK 组件。 第第 4 步步：完成 JDK 安装。单击“完成”退出安装程序，即完成了 JDK 的 安装。 用户手册 第 4 页 共 15 页 2.1.2 Tomcat 的安装的安装 Tomcat 作为一款著名的轻量级 web 容器经常被用来发布 java web 应用。 Tomcat 不仅技术先进、性能稳定，而其它的安装和配置过程都非常简单。并且， Tomcat 在 windows 和 Linux 下都有统一的安装包（.tar.gz 压缩包），将下载的 压缩包解压到目标路径即可。 Linux 下解压方式： rootGDGS # tar zxvf apche-tomcat-6.0.18.tar.gz Windows 下直接双击压缩包图标即可完成解压工作。 完成安装后，在/bin 下能够找到 startup 脚本，运行该脚本后 Tomcat 就被启动。完成启动后，在浏览器中输入 http:/localhost:8080，如能出 现如下页面说明 Tomcat 安装成功。 2.1.3 Web 应用程序部署应用程序部署 在上述运行环境搭建完成后，就可以开始 Web 应用程序的部署工作。整个 部署工作主要是使用 Tomcat 完成 Web 应用的发布。这个过程是通过配置 /conf/server.xml 文件来完成的。 用户手册 第 5 页 共 15 页 配置文件中配置项目发布的端口（port）、项目所在路径（docBase）及数 据库连接方式（Resource）即可。 修改完成配置文件后将 Tomcat 重启，待重启完成后在浏览器中输入 URL（例如：http:/IP 地址/）后会出现系统登录首页面。 2.2 数据库部署 数据库安装完成后，需要将已经开发完成的数据库导入到线上数据库服务 器中。数据库用户导入过程可以按照如下的步骤来完成。 第第 1 步步：打开控制台输入如下命令 oracleGDGS $ sqlplus /nolog 第第 2 步步：在出现的 sqlplus 命令提示符后输入 SQL conn /as sysdba 第第 3 步步：为了能够正确的导入数据，需要创建用户使用的表空间。例如， 使用如下语句来创建名为 PCMDB 的表空间。 SQLcreate tablespace PCMDB datafile /opt/app/oracle/oradata/plat/PCMDB.dbf size 2048M extent management local; 用户手册 第 6 页 共 15 页 第第 4 步步：创建数据库用户并授权。以创建登录名为 GDGS_GJPLATFORM，登录密码为 PASSWORD 的用户为例。; SQL create user GDGS_GJPLATFORM identified by PASSWORD default tablespace PCMDB； SQL grant connect, resource, create view to GDGS_GJPLATFORM; 第第 5 步步：使用 imp 工具导入用户数据。在进行该操作前需要退出 sqlplus 管 理工具。 SQL exit oracleGDGS $ imp system/password file=EXP_DATA.dmp fromowner= FROM_USER touser=TO_USER log=IMP_LOG.log 当 imp 工具完成导入后，系统数据库的部署工作也就完成了。如果数据库 有多个用户，那么重复上述流程即可。 2.3 系统部署信息汇总 XXXX 系统部署信息汇总系统部署信息汇总 版本1.6.0_21 JDK 安装路径/usr/local/jdk 版本Ver.6.0 Tomcat 安装路径/usr/local/tomcat 版本10.2.0.1.0 安装路径/opt/app/oracleOracle 数据库 数据库用户XXX
