Skip to content

Commit e71c4f2

Browse files
jiaoshuntianjiaoshuntian
committed
Fix document errors in the installation section
1 parent 239ca2e commit e71c4f2

File tree

4 files changed

+58
-118
lines changed

4 files changed

+58
-118
lines changed

‎CN/modules/ROOT/pages/v4.5/3.adoc‎

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,7 @@ IvorySQL数据库目前支持的操作系统包括但不限于CentOS 8.X、CentO
2525

2626
[[快速安装]]
2727
== 快速安装
28-
....
29-
快速开始示例所使用的操作系统为CentOS Stream 9。
30-
....
28+
快速开始示例所使用的操作系统为CentOS Stream 9。
3129
=== 从yum源安装IvorySQL数据库
3230

3331
** 安装前准备
@@ -52,16 +50,14 @@ gpgcheck=0
5250
```
5351
保存退出后，安装IvorySQL4
5452
```
55-
$ sudo dnf install -y IvorySQL-4.5
53+
$ sudo dnf install -y ivorysql4-4.5
5654
```
57-
....
5855

59-
正确安装后，数据库将被安装在/opt/IvorySQL-4.5/路径下的IvorySQL-version(如:IvorySQL-4.5)文件夹内
60-
....
56+
正确安装后，数据库将被安装在/usr/ivory-4/文件夹内
6157

6258
执行以下命令为ivorysql用户赋权：
6359
```
64-
$ sudo chown -R ivorysql:ivorysql /opt/IvorySQL-4.5
60+
$ sudo chown -R ivorysql:ivorysql /usr/ivory-4
6561
```
6662
[[配置环境变量]]
6763
** 配置环境变量
@@ -70,9 +66,9 @@ $ sudo chown -R ivorysql:ivorysql /opt/IvorySQL-4.5
7066

7167
将以下配置写入~/.bash_profile文件并使用source命令该文件使环境变量生效：
7268
```
73-
PATH=/opt/IvorySQL-4.5/bin:$PATH
69+
PATH=/usr/ivory-4/bin:$PATH
7470
export PATH
75-
PGDATA=/opt/IvorySQL-4.5/data
71+
PGDATA=/usr/ivory-4/data
7672
export PGDATA
7773
```
7874
```
@@ -82,16 +78,14 @@ $ source ~/.bash_profile
8278
** 数据库初始化
8379

8480
```
85-
$ initdb -D /opt/IvorySQL-4.5/data
81+
$ initdb -D /usr/ivory-4/data
8682
```
87-
....
88-
其中-D参数用来指定数据库的数据目录。更多参数使用方法，请使用initdb --help命令获取。
89-
....
83+
其中-D参数用来指定数据库的数据目录。更多参数使用方法，请使用initdb --help命令获取。
9084

9185
** 启动数据库服务
9286

9387
```
94-
$ pg_ctl -D /opt/IvorySQL-4.5/data -l ivory.log start
88+
$ pg_ctl -D /usr/ivory-4/data -l ivory.log start
9589
```
9690

9791
其中-D参数用来指定数据库的数据目录，如果<<配置环境变量>> 配置了PGDATA，则该参数可以省略。-l参数用来指定日志目录。更多参数使用方法，请使用pg_ctl --help命令获取。
@@ -100,7 +94,7 @@ $ pg_ctl -D /opt/IvorySQL-4.5/data -l ivory.log start
10094
查看确认数据库启动成功：
10195
```
10296
$ ps -ef | grep postgres
103-
ivorysql 3214 1 0 20:35 ? 00:00:00 /opt/IvorySQL-4.5/bin/postgres -D /opt/IvorySQL-4.5/data
97+
ivorysql 3214 1 0 20:35 ? 00:00:00 /usr/ivory-4/bin/postgres -D /usr/ivory-4/data
10498
ivorysql 3215 3214 0 20:35 ? 00:00:00 postgres: checkpointer
10599
ivorysql 3216 3214 0 20:35 ? 00:00:00 postgres: background writer
106100
ivorysql 3218 3214 0 20:35 ? 00:00:00 postgres: walwriter
@@ -138,14 +132,12 @@ Type "help" for help.
138132

139133
ivorysql=#
140134
```
141-
....
142-
其中-d参数用来指定想要连接到的数据库名称。IvorySQL默认使用ivorysql数据库，但较低版本的IvorySQL首次使用时需用户先连接postgres数据库，然后自己创建ivorysql数据库。较高版本的IvorySQL则已为用户创建好ivorysql数据库，可以直接连接。
135+
其中-d参数用来指定想要连接到的数据库名称。IvorySQL默认使用ivorysql数据库，但较低版本的IvorySQL首次使用时需用户先连接postgres数据库，然后自己创建ivorysql数据库。较高版本的IvorySQL则已为用户创建好ivorysql数据库，可以直接连接。
143136

144-
更多参数使用方法，请使用psql --help命令获取。
145-
....
137+
更多参数使用方法，请使用psql --help命令获取。
146138

147139
TIP: Docker运行IvorySQL时，需要添加额外参数，如 psql -d ivorysql -U ivorysql -h 127.0.0.1 -p 5434
148140

149141
现在可以开始使用IvorySQL啦！就是这么简单！
150142

151-
想要获得更多安装方式，请参考xref:v4.5/6.adoc[安装指南]
143+
想要获得更多安装方式，请参考xref:v4.5/6.adoc[安装指南]

‎CN/modules/ROOT/pages/v4.5/6.adoc‎

Lines changed: 17 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -35,27 +35,6 @@ gpgcheck=0
3535
$ sudo dnf install -y IvorySQL-4.5
3636
```
3737

38-
** 查看安装结果
39-
```
40-
dnf search IvorySQL
41-
```
42-
查看结果说明如下：
43-
|====
44-
| 序号 | 包名 | 描述
45-
| 1 | ivorysql4.x86_64 | IvorySQL客户端程序和库文件
46-
| 2 | ivorysql4-contrib.x86_64 | 随IvorySQL发布的已贡献的源代码和二进制文件
47-
| 3 | ivorysql4-devel.x86_64 | IvorySQL开发头文件和库
48-
| 4 | ivorysql4-docs.x86_64 | IvorySQL的额外文档
49-
| 5 | ivorysql4-libs.x86_64 | 所有IvorySQL客户端所需的共享库
50-
| 6 | ivorysql4-llvmjit.x86_64 | 对IvorySQL的即时编译支持
51-
| 7 | ivorysql4-plperl.x86_64 | 用于IvorySQL的过程语言Perl
52-
| 8 | ivorysql4-plpython3.x86_64 | 用于IvorySQL的过程语言Python3
53-
| 9 | ivorysql4-pltcl.x86_64 | 用于IvorySQL的过程语言Tcl
54-
| 10 | ivorysql4-server.x86_64 | 创建和运行IvorySQL服务器所需的程序
55-
| 11 | ivorysql4-test.x86_64 | 随IvorySQL发布的测试套件
56-
| 12 | ivorysql-release.noarch | 瀚高基础软件股份有限公司的Yum源配置RPM包
57-
|====
58-
5938
[[docker安装]]
6039
== docker安装
6140

@@ -104,7 +83,7 @@ $ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_4.5/
10483
```
10584
$ sudo yum --disablerepo=* localinstall *.rpm
10685
```
107-
数据库将被安装在/opt/IvorySQL-4.5/路径下。
86+
数据库将被安装在/usr/ivory-4/路径下。
10887

10988
[[源码安装]]
11089
== 源码安装
@@ -125,7 +104,7 @@ $ git checkout -b IVORY_REL_4_STABLE origin/IVORY_REL_4_STABLE
125104

126105
在IvorySQL目录下，执行以下命令进行配置，请使用--prefix指定安装目录:
127106
```
128-
$ ./configure --prefix=/usr/local/ivorysql/ivorysql-4
107+
$ ./configure --prefix=/usr/ivory-4/
129108
```
130109
** 编译
131110

@@ -166,7 +145,7 @@ $ sudo wget https://github.com/IvorySQL/IvorySQL/releases/download/IvorySQL_4.5/
166145
```
167146
$ sudo dpkg -i IvorySQL-4.5-a50789d-20250304.amd64.deb
168147
```
169-
数据库将被安装在/opt/IvorySQL-4.5/路径下。
148+
数据库将被安装在/usr/ivory-4/路径下。
170149

171150
== 启动数据库
172151
参考<<yum源安装>>、<<rpm安装>>、<<源码安装>>、<<deb安装>>的用户，需要手动启动数据库。
@@ -175,9 +154,9 @@ $ sudo dpkg -i IvorySQL-4.5-a50789d-20250304.amd64.deb
175154

176155
+
177156

178-
执行以下命令为安装用户赋权，示例用户为ivorysql，安装目录为/opt/IvorySQL-4.5/：
157+
执行以下命令为安装用户赋权，示例用户为ivorysql，安装目录为/usr/ivory-4/：
179158
```
180-
$ sudo chown -R ivorysql:ivorysql /opt/IvorySQL-4.5/
159+
$ sudo chown -R ivorysql:ivorysql /usr/ivory-4/
181160
```
182161
[[配置环境变量]]
183162
** 配置环境变量
@@ -186,9 +165,9 @@ $ sudo chown -R ivorysql:ivorysql /opt/IvorySQL-4.5/
186165

187166
将以下配置写入用户的~/.bash_profile文件并使用source命令该文件使环境变量生效：
188167
```
189-
PATH=/opt/IvorySQL-4.5/bin:$PATH
168+
PATH=/usr/ivory-4/bin:$PATH
190169
export PATH
191-
PGDATA=/opt/IvorySQL-4.5/data
170+
PGDATA=/usr/ivory-4/data
192171
export PGDATA
193172
```
194173
```
@@ -197,17 +176,15 @@ $ source ~/.bash_profile
197176
** 数据库初始化
198177

199178
```
200-
$ mkdir /opt/IvorySQL-4.5/data
201-
$ initdb -D /opt/IvorySQL-4.5/data
179+
$ mkdir /usr/ivory-4/data
180+
$ initdb -D /usr/ivory-4/data
202181
```
203-
....
204-
其中-D参数用来指定数据库的数据目录。更多参数使用方法，请使用initdb --help命令获取。
205-
....
182+
其中-D参数用来指定数据库的数据目录。更多参数使用方法，请使用initdb --help命令获取。
206183

207184
** 启动数据库服务
208185

209186
```
210-
$ pg_ctl -D /opt/IvorySQL-4.5/data -l ivory.log start
187+
$ pg_ctl -D /usr/ivory-4/data -l ivory.log start
211188
```
212189

213190
其中-D参数用来指定数据库的数据目录，如果<<配置环境变量>> 配置了PGDATA，则该参数可以省略。-l参数用来指定日志目录。更多参数使用方法，请使用pg_ctl --help命令获取。
@@ -216,7 +193,7 @@ $ pg_ctl -D /opt/IvorySQL-4.5/data -l ivory.log start
216193
查看确认数据库启动成功：
217194
```
218195
$ ps -ef | grep postgres
219-
ivorysql 130427 1 0 02:45 ? 00:00:00 /opt/IvorySQL-4.5/bin/postgres -D /opt/IvorySQL-4.5/data
196+
ivorysql 130427 1 0 02:45 ? 00:00:00 /usr/ivory-4/bin/postgres -D /usr/ivory-4/data
220197
ivorysql 130428 130427 0 02:45 ? 00:00:00 postgres: checkpointer
221198
ivorysql 130429 130427 0 02:45 ? 00:00:00 postgres: background writer
222199
ivorysql 130431 130427 0 02:45 ? 00:00:00 postgres: walwriter
@@ -254,8 +231,7 @@ TIP: Docker运行IvorySQL时，需要添加额外参数，参考：psql -d ivory
254231

255232
执行以下命令依次卸载：
256233
```
257-
$ sudo dnf remove -y IvorySQL-4.5
258-
$ sudo rpm -e ivorysql-release-4.2-1.noarch
234+
$ sudo dnf remove -y ivorysql4-4.5
259235
```
260236

261237
=== docker安装的卸载
@@ -272,7 +248,7 @@ $ docker rmi ivorysql/ivorysql:4.5-ubi8
272248
执行以下命令卸载并清理文件夹：
273249
```
274250
$ sudo yum remove --disablerepo=* ivorysql4\*
275-
$ sudo rm -rf /opt/IvorySQL-4.5
251+
$ sudo rm -rf /usr/ivory-4/
276252
```
277253

278254
=== 源码安装的卸载
@@ -281,13 +257,13 @@ $ sudo rm -rf /opt/IvorySQL-4.5
281257
```
282258
$ sudo make uninstall
283259
$ make clean
284-
$ sudo rm -rf /opt/IvorySQL-4.5
260+
$ sudo rm -rf /usr/ivory-4/
285261
```
286262

287263
=== deb安装的卸载
288264

289265
执行以下命令卸载数据库并清理文件夹：
290266
```
291267
$ sudo dpkg -P IvorySQL-4.5
292-
$ sudo rm -rf /opt/IvorySQL-4.5
293-
```
268+
$ sudo rm -rf /usr/ivory-4/
269+
```

‎EN/modules/ROOT/pages/v4.5/3.adoc‎

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ Currently, IvorySQL supports but is not limited to linux(CentOS 8.X/CentOS Strea
2424

2525
[[quick-installation]]
2626
== Quick installation
27-
....
28-
The operating system used for the quick start is CentOS Stream 9.
29-
....
27+
The operating system used for the quick start is CentOS Stream 9.
3028
=== yum installation
3129

3230
** Pre-requirements
@@ -51,7 +49,7 @@ gpgcheck=0
5149
```
5250
After saving and exiting, you can install IvorySQL 4 with the following steps
5351
```
54-
$ sudo dnf install -y IvorySQL-4.5
52+
$ sudo dnf install -y ivorysql4-4.5
5553
```
5654

5755
[[setting-environment-variables]]
@@ -61,9 +59,9 @@ $ sudo dnf install -y IvorySQL-4.5
6159

6260
Add below contents in ~/.bash_profile file and source to make it effective:
6361
```
64-
PATH=/opt/IvorySQL-4.5/bin:$PATH
62+
PATH=/usr/ivory-4/bin:$PATH
6563
export PATH
66-
PGDATA=/opt/IvorySQL-4.5/data
64+
PGDATA=/usr/ivory-4/data
6765
export PGDATA
6866
```
6967
```
@@ -73,29 +71,27 @@ $ source ~/.bash_profile
7371
** Initializing database
7472

7573
```
76-
$ initdb -D /opt/IvorySQL-4.5/data
74+
$ initdb -D /usr/ivory-4/data
7775
```
78-
....
79-
The -D option specifies the directory where the database cluster should be stored. This is the only information required by initdb, but you can avoid writing it by setting the PGDATA environment variable, which can be convenient since the database server can find the database directory later by the same variable.
76+
The -D option specifies the directory where the database cluster should be stored. This is the only information required by initdb, but you can avoid writing it by setting the PGDATA environment variable, which can be convenient since the database server can find the database directory later by the same variable.
8077

81-
For more options, refer to initdb --help.
82-
....
78+
For more options, refer to initdb --help.
8379

8480
** Starting IvorySQL service
8581

8682
```
87-
$ pg_ctl -D /opt/IvorySQL-4.5/data -l ivory.log start
83+
$ pg_ctl -D /usr/ivory-4/data -l ivory.log start
8884
```
8985

90-
The -D option specifies the file system location of the database configuration files. If this option is omitted, the environment variable PGDATA in <<setting-environment-variables>> is used. -l option appends the server log output to filename. If the file does not exist, it is created.
86+
The -D option specifies the file system location of the database configuration files. If this option is omitted, the environment variable PGDATA in <<setting-environment-variables>> is used. -l option appends the server log output to filename. If the file does not exist, it is created.
9187

92-
For more options, refer to pg_ctl --help.
88+
For more options, refer to pg_ctl --help.
9389

9490

9591
Confirm it’s successfully started:
9692
```
9793
$ ps -ef | grep postgres
98-
ivorysql 3214 1 0 20:35 ? 00:00:00 /opt/IvorySQL-4.5/bin/postgres -D /opt/IvorySQL-4.5/data
94+
ivorysql 3214 1 0 20:35 ? 00:00:00 /usr/ivory-4/bin/postgres -D /usr/ivory-4/data
9995
ivorysql 3215 3214 0 20:35 ? 00:00:00 postgres: checkpointer
10096
ivorysql 3216 3214 0 20:35 ? 00:00:00 postgres: background writer
10197
ivorysql 3218 3214 0 20:35 ? 00:00:00 postgres: walwriter
@@ -133,14 +129,12 @@ Type "help" for help.
133129

134130
ivorysql=#
135131
```
136-
....
137-
The -d option specifies the name of the database to connect to. ivorysql is the default database of IvorySQL. However,IvorySQL of lower versions need the users themselves to connect to postgres database at the first connection and then create the ivorysql database.The latest IvorySQL can do all these for users.
132+
The -d option specifies the name of the database to connect to. ivorysql is the default database of IvorySQL. However,IvorySQL of lower versions need the users themselves to connect to postgres database at the first connection and then create the ivorysql database.The latest IvorySQL can do all these for users.
138133

139-
For more options, refer to psql --help.
140-
....
134+
For more options, refer to psql --help.
141135

142136
TIP: When running IvorySQL in Docker, additional parameters need to be added, like: psql -d ivorysql -U ivorysql -h 127.0.0.1 -p 5434
143137

144138
Now you can start your journey of IvorySQL! Enjoy!
145139

146-
To explore additional installation methods, please refer to the xref:v4.5/6.adoc[Installation].
140+
To explore additional installation methods, please refer to the xref:v4.5/6.adoc[Installation].

0 commit comments

Comments
 (0)