Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
legacy-peer-deps=true
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ ping websoft9.com
traceroute websoft9.com

# Telnet
telnet websoft9.com 9090
telnet websoft9.com 9000

# Ping and traceroute
mtr websoft9.com
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,27 @@ sidebar_position: 1
slug: /upgrade-websoft9
---

# Upgrade Websoft9
# Upgrade Websoft9

## Upgrade Websoft9

The **Settings** page of the Websoft9 Console provides an automated online upgrade solution.
The install script supports both **fresh install** and **upgrade**, and auto-detects the current environment. Back up your data before upgrading.

You can also use below upgrade script:
```
wget -O install.sh https://artifact.websoft9.com/websoft9/release/install.sh && sudo bash install.sh
```

## Troubleshoot
> Upgrade does not affect deployed applications.

Below references for your troubleshoot after upgrade Websoft9
## Troubleshooting

### Can not open Git or Gateway interface?
#### Unable to access some features after upgrade?

**Description**: Can not access Git or Gateway interface at Websoft9 Console, and have network error
**Reason**: The local browser cache conflict with the Websoft9 server
**Description**: Cannot access Gateway or Repository interface at Websoft9 Console, showing network error
**Solution**: Clear your browser cache

Blow is the sample for your clear cache for Websoft9 on Microsoft Egde: F12 Shortcut to enter to browser's developer mode
Below is an example of clearing cache on Microsoft Edge: press F12 to enter browser developer mode

![](./assets/websoft9-edge-clearcache.png)


68 changes: 39 additions & 29 deletions i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,58 @@ sidebar_position: 0.1
slug: /login-console
---

# Login Websoft9 Console
# Login to Websoft9 Console

After installing the Websoft9, the next step is to login to the Websoft9 Console.
After [installing](./install) Websoft9, you can log in to the Websoft9 Console for configuration and management.

## Prepare
## Prerequisites

Below steps is need:
Before logging in, ensure the following:

- Open the inbound ports of Server at your Cloud security group:
1. **Open inbound ports** on your cloud security group:

- Required ports: **80, 443, 22, 9000**
- Optional ports (for application access): **9001-9999**
- **Required**: 80, 443, 9000
- **Optional** (for app access): 9001-9999

- Get the Server's [credentials](./credentials) that is shared with Websoft9 Console
## First Visit

## Login
1. Open your browser and visit: `http://<server-public-IP>:9000`
2. On first visit, the **Setup Wizard** will guide you to create an administrator account and configure basic settings
3. After setup, log in with the administrator account you just created

1. Access via local browser: `http://server-public-IP:9000`, the Websoft9 login page
![Websoft9 Login page](./assets/websoft9-loginpage.png)
> Websoft9 uses its own user system. The administrator account is created in the Setup Wizard and is independent of the server's operating system accounts.

> The latest version of Websoft9 enforces access via the HTTPS protocol. For users utilizing the Firefox browser, please visit https://InternetIP to access the Websoft9 boot page. Follow the instructions provided on the boot page to smoothly navigate to the Websoft9 login interface.
## Console Overview

2. Input the server's [username and password](./credentials), after a successful login, you will be directed to the console default page.

- **User name**: The server's administrator account, it is recommended to use `root` for the first login.
- **Password**: The server's administrator password.
After logging in, you will see the console dashboard:

![](./assets/websoft9-console-index.png)
![Websoft9 Console Dashboard](./assets/websoft9-console-index.png)

3. Click on **App Store** to view all available application templates.
![](./assets/websoft9-appstore.png)
The left sidebar menu is organized into two sections:

4. Click on **My Apps**to view the list of installed applications.
![](./assets/websoft9-myapps.png)
**Workspace**
| Menu | Description |
|------|-------------|
| Overview | Server status dashboard |
| Apps › My Apps | Manage installed applications (start, stop, restart, redeploy, backup, compose, etc.) |
| Apps › App Store | Browse and install 200+ open source app templates |
| Apps › Deploy | Custom Docker Compose deployment |
| Containers | Manage Docker containers and images |
| Gateway | Domain binding, reverse proxy, and SSL certificate management |
| Repository | Git repository hosting and code management |

## Related Topics

- [User account and credentials](./credentials)
- [Set Global domains for Websoft9](./domain-set#wildcard)
**System**
| Menu | Description |
|------|-------------|
| Terminal | Browser-based SSH terminal and file manager |
| Services | Core service status monitoring |
| Logs | Structured log viewer |
| Users | Multi-user accounts with role-based access control |
| Settings | Platform parameters, mirror acceleration, certificates, and global configuration |

## FAQ

#### Can login Websoft9 using key pair?
## Related Topics

No, you should set password for user account and cany keep key pair for SSH
- [Set Global Domain for Websoft9](./domain-set#wildcard)
- [Deploy App via App Store](./appstore-guide)
- [Deploy App via Runtime](./runtime)
- [User Accounts & Credentials](./credentials)
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ ping websoft9.com
traceroute websoft9.com

# Telnet
telnet websoft9.com 9090
telnet websoft9.com 9000

# Ping 与 traceroute 组合
mtr websoft9.com
Expand Down
12 changes: 5 additions & 7 deletions versioned_docs/version-2.0/admin/upgrade/websoft9.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,22 @@ slug: /upgrade-websoft9

## 升级 Websoft9

Websoft9 控制台的【设置】页面提供了自动化的在线升级方案。
安装脚本同时支持**全新安装**和**升级**,会自动检测当前环境。升级前建议先备份数据。

也可以使用下面的一键升级脚本:
```
wget -O install.sh https://artifact.websoft9.com/websoft9/release/install.sh && sudo bash install.sh
```

## 故障处理
> 升级过程不会影响已部署的应用。

升级后,可能出现的故障
## 故障处理

#### 网关、仓库 等功能打不开
#### 升级后部分功能界面无法打开

**描述**:登录 Websoft9 后,网关、仓库等功能界面进不去,显示网络超时的错误
**分析**:升级后本地浏览器缓存数据与服务器端不匹配
**方案**:清除本地浏览器缓存

下面是 Microsoft Egde 浏览器下清除缓存的范例:键盘 F12 进入浏览器的检查(开发者调试)模式后参考下图操作
下面是 Microsoft Edge 浏览器下清除缓存的范例:键盘 F12 进入浏览器的检查(开发者调试)模式后参考下图操作

![](./assets/websoft9-edge-clearcache.png)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 33 additions & 17 deletions versioned_docs/version-2.0/starter/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,42 +5,58 @@ slug: /login-console

# 登录 Websoft9 控制台

在成功[安装](./install) Websoft9 服务器后,接下来需要登录 Websoft9 控制台进行配置和管理。
在成功[安装](./install) Websoft9 后,即可登录 Websoft9 控制台进行配置和管理。

## 准备

在登录 Websoft9 控制台之前,请确保完成以下准备工作:
登录之前,请确保完成以下准备工作:

1. **开放服务器安全组入方向端口**:

- **必要端口**:80, 443, 22, 9000
- **必要端口**:80, 443, 9000
- **可选端口**(供应用访问):9001-9999

2. **获取服务器的账号密码**:
## 首次访问

Websoft9 与服务器共享相同的[账号密码](./credentials),并有必要的[权限要求](./credentials#convert-normal)。
1. 本地浏览器访问: `http://服务器公网IP:9000`
2. 首次访问将进入**设置向导**,根据提示创建管理员账户并完成基本配置
![Websoft9 设置向导](./assets/websoft9-setupwizard.png)
3. 设置完成后,使用刚创建的管理员账户登录控制台
![Websoft9 登录界面](./assets/websoft9-loginpage.png)

## 登录 Websoft9
> Websoft9 使用独立的用户系统,管理员账户在设置向导中创建,与服务器操作系统账号无关。

1. 本地浏览器访问: `http://服务器公网IP:9000`,进入 Websoft9 登录界面
![Websoft9 登录界面](./assets/websoft9-loginpage.png)
## 控制台概览

- 用户名:Websoft9 所在的 [服务器的账号](./credentials),首次使用建议 `root`
- 密码:服务器密码
登录成功后进入控制台首页:

> 目前新版本的 Websoft9 强制使用 HTTPS 协议进行访问。对于使用 Firefox 浏览器的用户,请访问 https://服务器公网IP,以进入 Websoft9 引导页面。根据引导页面的提示,您将能够顺利进入 Websoft9 登录界面。
![Websoft9 控制台首页](./assets/websoft9-console-index.png)

2. 登录成功后,进入控制台概述页面,显示服务器的状态信息
![](./assets/websoft9-console-index.png)
左侧导航菜单分为两大区域:

3. 点击 **应用商店**,查看可安装的所有应用模板
![](./assets/websoft9-appstore.png)
**工作区**
| 菜单 | 功能 |
|------|------|
| 概览 | 服务器状态总览 |
| 应用 › 我的应用 | 管理已安装的应用(启动、停止、重启、重建、备份、编排等) |
| 应用 › 应用商店 | 浏览和安装 200+ 开源应用模板 |
| 应用 › 部署 | 自定义 Docker Compose 部署 |
| 容器 | 管理 Docker 容器和镜像 |
| 网关 | 域名绑定、反向代理和 SSL 证书管理 |
| 仓库 | Git 仓库托管和代码管理 |

4. 点击 **我的应用**,查看已安装的应用列表
![](./assets/websoft9-myapps.png)
**系统**
| 菜单 | 功能 |
|------|------|
| 终端 | 浏览器内 SSH 终端和文件管理 |
| 服务 | 核心服务状态监控 |
| 日志 | 结构化日志查看 |
| 用户 | 多用户账号与角色权限管理 |
| 设置 | 平台参数、镜像加速、证书等全局配置 |

## 相关主题

- [为 Websoft9 设置全局域名](./domain-set#wildcard)
- [使用模板一键部署应用](./appstore-guide)
- [使用程序环境部署应用](./runtime)
- [用户账号与权限](./credentials)
Loading