Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
chendelin1982 committed Apr 30, 2024
1 parent 1e753ac commit 913b0ad
Show file tree
Hide file tree
Showing 24 changed files with 202 additions and 573 deletions.
Binary file added docs/apps/assets/phpmyadmin-backend-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/phpmyadmin-login-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/plausible-register-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/portainer-register-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/prestashop-backend-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/prometheus-backend-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/pydio-adminconsole-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/pydio-userconsole-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/rabbitmq-backend-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/apps/assets/redash-backend-websoft9.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 25 additions & 65 deletions docs/apps/phpmyadmin.md
Expand Up @@ -15,91 +15,51 @@ import Meta from './_include/phpmyadmin.md';

## 入门指南{#guide}

### 初始化{#wizard}

Websoft9 控制台安装 phpMyAdmin 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取登录信息。

### 连接 MySQL{#phpmyadminconnect}

如果部署方案中包含 phpMyAdmin 等图形化工具,使用就更加便捷方便:

1. 本地浏览器电脑浏览器访问后,进入phpMyAdmin
![登录phpMyadmin](https://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-login-websoft9.png)

2. 输入 MySQL 的连接信息
- 服务器:MySQL 主机名(Websoft9 控制台安装的 MySQL 的容器名)
- 账号:root

3. 登录成功后,可以管理任意数据库
![phpMyadmin](https://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-adddb-websoft9.png)

### 修改 root 密码{#phpmyadminmodifypw}

1. 登录 phpMyAdmin 后,默认页面-常规设置,点击【修改密码】
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-modifypw-websoft9.png)

2. 修改密码并保存,然后退出刷新浏览器后生效

### 新增数据库{#phpmyadmindb}

1. 登录phpMyAdmin后,点击左侧菜单栏的“新建”,进入如下的数据库创建界面

![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-adddb-websoft9.png)

2. 填写数据库名->点击创建按钮,一个新的数据库变建立成功

3. 默认情况下,root拥有新建的数据库的全部权限
1. Websoft9 控制台安装 phpMyAdmin 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取访问 URL。

### 新增数据库用户{#phpmyadminuser}
2. 进入phpMyAdmin 的登录界面,此时需要输入的被连接的 MySQL/MariaDB 的信息

- 服务器:MySQL 主机名(Host),支持内网和外网连接

> 数据库用户与数据库是分离的,是“多对多”的关系。可以通过关联使得某个用户具有某个数据库的权限
- 内网连接:内网IP/容器名/服务名
- 外网:云数据库厂商提供的主机 URL

1. 登录phpMyAdmin后,点击左侧菜单栏中新打算对其新增用户的数据库(例如:mywebsoft9)

2. 点击顶部菜单栏的“权限”,找到“新增用户账户”,如下新增用户界面
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-adduser-websoft9.png)
- 账号:root

3. 根据上图填写用户名、主机地址和密码,然后关联对应的数据库和勾选权限设置
- 密码:数据库密码

4. 点击“执行”,就完成新增用户和数据库关联了
![登录phpMyadmin](./assets/phpmyadmin-login-websoft9.png)

说明:也可以登录phpMyAdmin的默认页面后,点击顶部菜单上“账户”,对用户和权限进行管理
3. 登录成功后,可以方便的管理数据库、运行 SQL

### 数据库导入和导出{#phpmyadminexportimport}
![phpMyadmin 后台](./assets/phpmyadmin-backend-websoft9.png)

> 导出即备份数据库,导入即恢复数据库。这个两个操作对 phpMyAdmin 来说比较简单,具体如下:
### 管理数据库

1. 登录phpMyAdmin后,选择您需要操作的数据库后,点击顶部菜单栏的“导出”
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-export-websoft9.png)
- 修改密码:phpMyAdmin 首页 > 常规设置 > 修改密码
- 新建数据库:phpMyAdmin 左侧菜单 > 新建
- 新建用户:phpMyAdmin 顶部菜单 > 账户
- 备份恢复:phpMyAdmin 顶部菜单 > 导入或导入

2. 选择导出方式(默认为“快速”)和格式(默认为“SQL”),点击“执行”按钮
## 配置选项{#configs}

3. 数据库备份文件(.sql后缀)生成后,保存到本地完成导出工具
- 多语言(✅)
- 配置文件:/etc/phpmyadmin/config.user.inc.php

4. 恢复数据库,对应的是“导入”操作,具体参考下图
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/phpmyadmin-import-websoft9.png)
## 管理维护{#administrator}

5. 导入文件特别要注意字符集兼容性
### 远程访问{#remote}

### MySQL 远程访问{#phpmyadminremote}
开启数据库的远程访问,只需将 root 账号的主机名修改为任意主机(%):

在phpMyAdmin中开启远程只需要将root账号的访问方式改成“任意方式访问”,具体如下:
1. phpMyAdmin 顶部菜单 > 账户,编辑用户的 "登录信息"
2. 主机名选项中,选择 "任意主机",点击 "执行" 后生效

1. 打开账户->找到主机名为127.0.0.1的root用户,点击“修改权限”
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/mysql-openremote001-websoft9.png)
2. 在“登录信息”选项卡中,将“主机名”下拉菜单选项更改为“任意主机”,点击执行
![](http://libs.websoft9.com/Websoft9/DocsPicture/zh/mysql/mysql-openremote002-websoft9.png)
3. 以上两步就完成了开启远程连接的工作

### 修改导入文件大小限制
### 文件大小限制

phpMyAdmin 默认可导入的文件大小有限制,可通过修改编排文件的 .env 中的 `UPLOAD_LIMIT=20M` 字段。

## 配置选项{#configs}

- 多语言(✅)
- 配置文件:/etc/phpmyadmin/config.user.inc.php

## 管理维护{#administrator}

## 故障
9 changes: 6 additions & 3 deletions docs/apps/plausible.md
Expand Up @@ -14,14 +14,17 @@ import Meta from './_include/plausible.md';

## 入门指南{#guide}

### 初始化{#wizard}
### 初始化向导{#wizard}

Websoft9 控制台安装 Plausible 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取登录信息。
1. Websoft9 控制台安装 Plausible 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取访问网站。
![](./assets/plausible-register-websoft9.png)

2. 根据向导依次完成:账号设置、设置被统计网站 URL等步骤

## 配置选项{#configs}

## 管理维护{#administrator}
- 多网站监控(√)

## 管理维护{#administrator}

## 故障
26 changes: 19 additions & 7 deletions docs/apps/portainer.md
Expand Up @@ -14,17 +14,28 @@ import Meta from './_include/portainer.md';

## 入门指南{#guide}

Websoft9 集成 Portainer 作为唯一个容器可视化管理平台,100% 保持其原生性。
Websoft9 已内置运行的 Portainer,建议直接使用 Websoft9 控制台 "容器" 管理功能。

所以,Portainer 的使用参考:[Websoft9 容器指南](./function/container)
如果您已经在 Websoft9 应用商店额外安装 Portainer,请参考下面的指引:

### 设置 Environments
### 初始化

Portainer 应用启动后,默认没有设置任何 Environments(包括本机 local):
1. Websoft9 控制台安装 Portainer 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取访问网站。
![](./assets/portainer-register-websoft9.png)

- 如果你想要管理本机,建议直接使用 Websoft9 内置的 Portainer (Websoft9 控制台 > 容器)
- 如果你想管理其他服务器,请通过 Portainer 菜单的 Administration > Environment-related > Environments 增加本管理的节点
2. 根据向导完成管理员账号设置,进入后台后,系统提示设置 Environments

- 管理本机的容器(推荐方案):删除本次安装的 Portainer,直接使用 Websoft9 控制台 "容器" 管理功能

- 管理本机的容器:修改 Portaier 编排文件,取消 `/var/run/docker.sock` 那行的注释,重建应用后生效

- 管理非本机的容器,请根据 Environments 提示设置连接方式

3. 完成 Environments 设置及连接后,方可开始管理容器

### 操作指南

参考:[Websoft9 容器指南](./function/container)

## 配置选项

Expand All @@ -38,4 +49,5 @@ Portainer 应用启动后,默认没有设置任何 Environments(包括本机

#### Portainer 无法进入初始页面?

为了安全性,Portainer 安装好后几分钟内没进入初始化页面会锁定页面。须重启 Portainer 应用即可进入初始化页面。
问题原因:为了安全性,Portainer 安装好后几分钟内没进入初始化页面会锁定页面
解决方案:重启 Portainer 应用
130 changes: 35 additions & 95 deletions docs/apps/postgresql.md
Expand Up @@ -15,120 +15,60 @@ import Meta from './_include/postgresql.md';

### 连接数据库

docker exec 到容器,即可使用 psql 连接数据库
1. Websoft9 控制台安装 PostgreSQL 后,通过 "我的应用" 查看应用详情,在 "访问" 标签页中获取用户名和密码

2. 进入 PostgreSQL 容器的命令模式,使用 psql 连接数据库

```
$ psql -d postgresql -U postgresql
psql (15.0 (Debian 15.0-1.pgdg110+1))
# 测试基于 host 访问(需密码)
$ psql -h postgres -U postgres
Password for user postgres:
psql (15.6 (Debian 15.6-1.pgdg120+2))
Type "help" for help.

postgresql=#
postgres=#
# 测试本地 local 访问(无需密码)
psql -d postgres -U postgres
```

### 图形化工具{#pgadmin}

参考:[pgAdmin](./pgadmin)

### 开启远程访问

PostgreSQL 应用默认已经绑定到宿主机外网端口,只需要确保安全组放通对应的端口即可。

如果取消了容器与宿主机的端口绑定,而是采用网关的 **Streams** 转发模式,需要确保:

1. postgresql.conf 有配置项 `listen_addresses = '*'`
2. pg_hba.conf 有配置项 `host all all 0.0.0.0/0 md5`

## 配置选项{#configs}

##### 默认账号
### 远程访问

PostgreSQL 本身并没有固定的管理员账号,但 Websoft9 设置 `postgres` 作为默认账号名称。
#### 端口绑定访问

##### 支持的数据类型

PostgreSQL 支持官方的数据类型,包括:数据、JASON、JSONB 以及几何类型,还可以使用 SQL 命令创建自定义类型

##### C/S 架构组成部分

PostgreSQL 本身是一个 C/S 架构的程序,即包括客户端程序和服务器程序。

* 客户端程序:psql, clusterdb, pgAdmin等
* 服务器程序:initdb, pg_ctl, postgres, postmaster, pg_upgrade等

##### 连接方式

PostgreSQL 允许四种[连接方式](https://www.cnblogs.com/flying-tiger/p/5983588.html?tdsourcetag=s_pcqq_aiomsg),主要包括:

* local: 基于 Unix 域套接字的连接方法,域套接字是进程间的一种非网络通信机制,效率高,安全可靠
* host: 基于 TCP/IP 的连接,允许非 SSL 连接,默认值只允许 localhost 本地连接。
* hostssl: 基于 TCP/IP 的 SSL 加密连接
* hostnossl: 基于 TCP/IP 的非 SSL 连接

##### 认证方法

PostgreSQL 常见的[认证方法](https://www.postgresql.org/docs/current/auth-methods.html)包括:
PostgreSQL 应用默认已经绑定到宿主机外网端口,只需要确保安全组放通对应的端口即可。

* reject: 拒绝某一网段的少数特定主机
* md5: 双种MD5加密
* password: 明文密码
* scram-sha-256: 基于SASL的加密认证,是 PostgreSQL 最安全的认证方式,但不支持 10 以下的版本
* trust: 完全信任
* peer:基于 unix socket 免密连接
#### 转发桥接访问

##### 配置文件
如果 PostgreSQL 容器端口没有绑定到宿主机,可以通过 Websoft9 网关的 **Streams** 转发模式桥接访问,但需确保:

PostgreSQL 有两个重要的全局配置文件:
1. postgresql.conf 配置项 `listen_addresses = '*'`
2. pg_hba.conf 配置项 `host all all 0.0.0.0/0 md5`

* postgresql.conf 主要负责配置文件位置、资源限制、集群负责等
* pg_hba.conf 主要负责客户端的连接和认证
## 配置选项{#configs}

##### 命令行
- 默认用户:PostgreSQL 本身并没有固定的管理员账号,但 Websoft9 设置 `postgres` 作为默认账号名称
- 客户端:psql, clusterdb, pgAdmin 等
- 服务端:initdb, pg_ctl, postgres, postmaster, pg_upgrade 等
- [四种连接方式](https://www.cnblogs.com/flying-tiger/p/5983588.html?tdsourcetag=s_pcqq_aiomsg):local, host, hostssl, hostnossl
- [认证方式](https://www.postgresql.org/docs/current/auth-methods.html):reject, md5, password, trust, peer, scram-sha-256
- 配置文件(已挂载):
- /var/lib/postgresql/data/postgresql.conf
- /var/lib/postgresql/data/pg_hba.conf
- 命令行:`psql`
- [API](https://www.postgresql.org/about/news/postgresql-restful-api-1616/)

PSQL 是 PostgreSQL 自带的命令行客户端工具,有非常丰富的功能。
## 管理维护{#administrator}

先切换到 postgre 用户,在运行 `psql` 命令,即可使用 psql 连接数据库
### 重置密码

在容器命令模式下,使用 `psql -d postgres -U postgres` 无需验证下登录,再修改密码:
```
$ docker exec -it postgresql psql --help
psql is the PostgreSQL interactive terminal.
Usage:
psql [OPTION]... [DBNAME [USERNAME]]
ALTER USER postgres WITH PASSWORD 'postgres'
```

##### API

[PostgreSQL RESTful API](https://www.postgresql.org/about/news/postgresql-restful-api-1616/)


## 管理维护{#administrator}

### 密码管理

对于 PostgreSQL 来说,由于可以通过 Unix 套字节在无需验证的情况下登录数据库,因此修改密码和重置密码操作相同:
```
$ psql -d postgresql -U postgresql
# 修改密码
$ ALTER USER postgres WITH PASSWORD 'postgres';
$ exit psql \q
```
### PostgreSQL 备份与恢复

PostgreSQL上的应用备份有多种[备份方案](https://www.postgresql.org/docs/12/backup.html),常见包括:

* 使用 pg_dump, pg_dumpall, pgAdmin, phpPgAdmin等工具进行数据库导出(SQL转存)
* 使用 pg_basebackup等工具实现增量备份和基于时间的恢复
* 数据库文件目录直接复制


## 故障

#### 运行 psql 命令显示 "cannot be run as root Failure, exiting"?

为了安全考量,默认安装已经创建了一个数据库账号 `postgres`,如果使用 `root` 账号登录,请切换用户后再使用 psql
```
sudo -i -u postgres
```
## 故障

0 comments on commit 913b0ad

Please sign in to comment.