diff --git a/.npmrc b/.npmrc new file mode 100644 index 000000000..e9ee3cb4d --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +legacy-peer-deps=true \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/faq.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/faq.md index 5ebeb060e..d28705f6b 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/faq.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/faq.md @@ -9,54 +9,32 @@ Please refer to the FAQ below to resolve your issue, if you cannot find the solu ## Websoft9 Console -### 500 Internal Server Error? +### Can't access Websoft9 Console?{#blank} -**Description**: When checking the logs of websoft9-apphub container, 500 Internal Server Error appears. +Common causes include: -**Reason**: The websoft9-apphub container is working abnormally or it can not connect other websoft9 containers - -**Solution**: Run the following commands to check the cause of the error - - ``` - docker exec -it websoft9-apphub cat /websoft9/apphub/logs/apphub_error.log - ``` - -### Can not open App Store or My Apps? - -**Description**: I can login Websoft9 Console, but can not open "App Store" or "My Apps" interface - -**Reason**: websoft9 containers working abnormally or **80** port not enabled - -**Solution**: Run the following commands to check the cause of the error - - ``` - docker logs websoft9-proxy - docker exec -it websoft9-apphub cat /websoft9/apphub/logs/apphub_error.log - ``` - -### Login Websoft9 failed{#login} - -Using multiple reasons can cause login failure: - -* Security Group port **9000** not enabled +* Security Group port **9000** not enabled (**most common cause**) * Websoft9 installation failed -* Network access failed for your instance -* Local browser's cookie or session -* Websoft9 Console(Cockpit) port is reset to **9090** -* Your Linux not allowed password login +* Network access failed for your server +* Product failure itself -#### Cockpit console port is reset to 9090? +If none of the above solves your issue, contact [Support](./helpdesk). -When user running `yum update` or `apt upgrade`, Cockpit may be reset to **9090** port and you can not login to Websoft9 Console +### Console accessible but features not working? -1. Login to Websoft9 Console by `http://IP:9090` -2. Set port to **9090** by **Settings > System Settings** +When you can log in but cannot access App Store, My Apps, or other core features, run the following commands to diagnose: -> You can set port by repeating step2 to your default port +``` +# View Websoft9 container logs +docker logs websoft9 -### websoft9.service starting failed? +# Check container health +docker ps --filter "name=websoft9" +``` -1. Troubleshooting compute resource limit +### Websoft9 service fails to start? + +1. Check compute resource limits ```shell # View processes ps aux @@ -68,16 +46,25 @@ When user running `yum update` or `apt upgrade`, Cockpit may be reset to **9090* free -lh ``` -2. Check the error logs +2. Check Websoft9 container logs ```shell - # View the Websoft9 service container logs - docker logs websoft9-apphub - docker logs websoft9-git - docker logs websoft9-proxy - docker logs websoft9-deployment - - # View Websoft9 service status and logs - systemctl status websoft9 + docker logs websoft9 + ``` + +3. Diagnose based on error logs + +### How to reset admin password? + +```bash +rm -f /opt/websoft9/data/config/product-auth/product-auth.sqlite +rm -f /opt/websoft9/data/config/setup-wizard/state.json +docker restart websoft9 +``` +After restart, the setup wizard will launch to create a new administrator account. + +### Websoft9 default port conflict?{#portconflict} + +Run `netstat -tunlp` to check which ports are already in use on the server. journalctl -u websoft9 `` diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/howto/method/tree.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/howto/method/tree.md index 3fb7c020f..5f060a48a 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/howto/method/tree.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/troubleshoot/howto/method/tree.md @@ -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 diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/upgrade/websoft9.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/upgrade/websoft9.md index a7014f4d2..7b12991c5 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/upgrade/websoft9.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/admin/upgrade/websoft9.md @@ -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://websoft9.github.io/websoft9/install/install.sh && bash install.sh --execute_mode "upgrade" +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) diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/architecture.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/architecture.md index 03bab7b4d..74ad5aa7b 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/architecture.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/architecture.md @@ -22,17 +22,38 @@ Websoft9 is an application-centric microservices architecture. ## Architecture diagram -The technical elements used by Websoft9 include Linux, Docker, Gateway, service discovery, application orchestration, Git. - -The corresponding product architecture diagram is shown below: - -![](/img/websoft9-architecture.png) - - -- **Apphub**: Application management service, responsible for the entire life cycle of the application -- **Git**: Git acts as the single source of truth for system state at GitOps -- **Deployment**: Continuous deployment -- **Gateway**: Publishing and controlling access to the application. +Websoft9 uses a **single-container integrated control plane** architecture. All core services run inside one Docker container. + +```mermaid +graph TB + subgraph Host["Host Machine"] + subgraph Container["Websoft9 Container"] + Console["Console
React 19 + TS + MUI
:9000"] + AppHub["AppHub
Python FastAPI
/api"] + Gitea["Gitea
Git Repository"] + Portainer["Portainer
Container Mgmt"] + NPM["Nginx Proxy Manager
Reverse Proxy & SSL
:80 :443"] + end + DockerSocket["Docker Socket
/var/run/docker.sock"] + DataVolumes["Data Volumes
/opt/websoft9/data"] + end + + User["Browser"] -->|":9000"| Console + Console -->|"/api/*"| AppHub + AppHub --> Portainer + AppHub --> NPM + AppHub --> Gitea + AppHub --> DockerSocket + NPM -->|":80/:443"| Internet["External Network"] +``` + +### Core Components + +- **Console**: Web management UI built with React 19 + TypeScript + Vite + MUI, served at port `9000` +- **AppHub**: Business logic API built with Python FastAPI, handles app management, auth, proxy, backup, and settings +- **Gitea**: Embedded Git repository service for hosting application templates and code +- **Portainer**: Embedded container management service for Docker container and stack lifecycle +- **Nginx Proxy Manager**: Reverse proxy handling domain binding and Let's Encrypt SSL certificates, bound to ports `80` and `443` ## Open Souce diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/cli.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/cli.md index 444d1954f..643f430d4 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/cli.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/develop/cli.md @@ -5,22 +5,35 @@ sidebar_position: 1.2 # CLI -AppHub, the core microservice of Microsoft9, provides a CLI for managing applications. +Websoft9 provides a command-line tool for configuration management and operations. -To use it, enter the Apphub container in command mode: +Enter the Websoft9 container to use it: ``` -$ docker exec -it websoft9-apphub bash -$ apphub --help +$ docker exec -it websoft9 bash +$ websoft9 --help -Usage: apphub [OPTIONS] COMMAND [ARGS]... +Usage: websoft9 [OPTIONS] COMMAND [ARGS]... Options: --help Show this message and exit. Commands: - genkey Generate a new API key - getconfig Get a config value - getkey Get the API key - setconfig Set a config value + getconfig Get config values + setconfig Set a config value + setsysconfig Set a system config value + upgrade Upgrade App Store resources +``` + +### Common Examples + +```bash +# View all configuration +docker exec -it websoft9 websoft9 getconfig + +# Sync latest App Store resources +docker exec -it websoft9 websoft9 upgrade apps + +# Reset admin password (interactive prompt) +docker exec -it websoft9 websoft9 resetpwd ``` \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/cloud/config/huaweicloud.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/cloud/config/huaweicloud.md index 1630da96e..39c1a11f7 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/cloud/config/huaweicloud.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/cloud/config/huaweicloud.md @@ -43,7 +43,7 @@ Websoft9 image for Flexus is not display all applications at **App Store**. Below commands is the example for you to enable applications **phpMyAdmin，pgAdmin，CloudBeaver** to display at Websoft9 App Store. ``` -docker exec -i websoft9-apphub apphub setconfig --section initial_apps --key keys --value $(docker exec -i websoft9-apphub apphub getconfig --section initial_apps --key keys),phpmyadmin,cloudbeaver,pgadmin +docker exec -i websoft9 websoft9 setconfig --section initial_apps --key keys --value $(docker exec -i websoft9 websoft9 getconfig --section initial_apps --key keys),phpmyadmin,cloudbeaver,pgadmin ``` Then, you can install them by one-click diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/container/server.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/container/server.md index 2dd86e4ac..e697525d5 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/container/server.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/container/server.md @@ -15,7 +15,7 @@ You may need to set your Docker when using Websoft9 for applications hosting. If there not have Docker on your server, please run below command to install it. ``` -wget -O - https://websoft9.github.io/websoft9/install/install_docker.sh | bash +wget -O - https://artifact.websoft9.com/websoft9/release/install_docker.sh | sudo bash ``` ### Add your registry-mirrors{#imagespeed} diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/monitor/logs.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/monitor/logs.md index 87feb20fe..fe32a1c51 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/monitor/logs.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/monitor/logs.md @@ -7,7 +7,7 @@ slug: /monitor-logs ## Application logs -Excuse command `docker logs websoft9-apphub` to get application logs +Excuse command `docker logs websoft9` to get application logs ## Container logs diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/plan/deployment.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/plan/deployment.md index d6ae985c8..a56e1611c 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/plan/deployment.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/guide/plan/deployment.md @@ -119,7 +119,7 @@ Yes, you can pull application's all images before installation. Take **wordpress ``` # Copy docker compose library to host machine -docker cp websoft9-apphub:/websoft9/library /tmp/applibary +docker cp websoft9:/websoft9/library /tmp/applibary # list all applications ls /tmp/applibary diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/linux.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/linux.md index 72b462281..f60d02171 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/linux.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/linux.md @@ -7,42 +7,34 @@ title: "For Linux" # Installation for Linux -The Linux package has different container services and tools required to run Websoft9. Most users can install it without laborious configuration. +Websoft9 currently only supports installation on Linux hosts. -## Automatic installation +## Install & Upgrade -To install Websoft9, you need root access; otherwise, use `sudo su` before running the script: +The install script supports both **fresh install** and **upgrade**, and auto-detects the current environment. Back up your data before upgrading. ``` -# Installation with default parameters -wget -O install.sh https://artifact.websoft9.com/release/websoft9/install.sh && bash install.sh +# Quick install +wget -O install.sh https://artifact.websoft9.com/websoft9/release/install.sh && sudo bash install.sh -# Custom Parameter Installation -# -- channel release | dev -# --port -# --version -# --path - -wget -O install.sh https://artifact.websoft9.com/release/websoft9/install.sh && bash install.sh --port 9000 --channel release --path "/data/websoft9/source" --version "latest" +# Custom options +sudo bash install.sh --console-port 9000 --path "/data/websoft9/source" --version "latest" ``` -> Upgrade Websoft9 by running the same script. - -## Offline installation - -Computers in an offline environment are isolated from the public internet as a security measure. +> Upgrade does not affect deployed applications. -If you plan to deploy Websoft9 on a physically-isolated and offline network, please contact [Websoft9 Support Team](./helpdesk). +## Offline Installation +For air-gapped environments without internet access, please contact [Websoft9 Support Team](./helpdesk). -## Uninstall +## Uninstall -Websoft9 supports uninstallation and allows users to choose whether to keep data. +Websoft9 supports uninstallation. Data is **retained by default**. To fully purge, use `--purge` mode. ``` -curl https://websoft9.github.io/websoft9/install/uninstall.sh | bash -``` - -## Troubleshoot +# Uninstall (keep data) +curl -fsSL https://artifact.websoft9.com/websoft9/release/uninstall.sh | sudo bash -For troubleshooting details, see [Troubleshooting Websoft9](./faq#websoft9-console) issues. \ No newline at end of file +# Full purge +sudo bash uninstall.sh --purge --yes +``` \ No newline at end of file diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/readme.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/readme.md index f97e56164..878dc07fe 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/readme.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/method/readme.md @@ -6,7 +6,7 @@ slug: /install # Installation methods -You can install Websoft9 on most [GNU/Linux distributions](https://websoft9.github.io/websoft9/version.json), on several [cloud providers](./install-cloud), and in private cloud. +You can install Websoft9 on most [GNU/Linux distributions](https://artifact.websoft9.com/websoft9/release/version.json), on several [cloud providers](./install-cloud), and in private cloud. Before installing Websoft9, you should balance performance, reliability, ease of administration (backups, upgrades, and troubleshooting) with the cost of hosting. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/requirements.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/requirements.md index db9328370..d798da4a8 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/requirements.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/install/requirements.md @@ -33,7 +33,7 @@ Websoft9 requires internet access with stable bandwidth not less than **100M/s** ## Operating system{#os} -Websoft9 supports major [Linux distributions](https://websoft9.github.io/websoft9/version.json) like Red Hat, CentOS Steam, RockyLinux, Oracle Linux, Debian, and Ubuntu. +Websoft9 supports major [Linux distributions](https://artifact.websoft9.com/websoft9/release/version.json) like Red Hat, CentOS Steam, RockyLinux, Oracle Linux, Debian, and Ubuntu. If you want to install Websoft9 at [Windows or macOS](./install-windows), you need to install VM software fist. diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/reference/parameter.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/reference/parameter.md index 0ef87b0b5..7692de97f 100755 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/reference/parameter.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/reference/parameter.md @@ -11,11 +11,9 @@ Various parameters such as server, network, port and path involved in Websoft9 a ### Websoft9 Console -- **Websoft9 installation configuration directory**: */data/websoft9/source* -- **Websoft9 Docker Compose directory**: */data/websoft9/source/docker* -- **Websoft9 Systemd configuration directory**: */opt/websoft9 -- **Websoft9 plugin directory**: */usr/share/cockpit -- **Websoft9 backup directory**: */data/websoft9/vl_backup +- **Websoft9 installation directory**: */opt/websoft9* +- **Websoft9 data directory**: */opt/websoft9/data* +- **Websoft9 backup directory**: */opt/websoft9/data/backups* - **Websoft9 application persistent storage directory**: */var/lib/docker/volumes* ### Docker on the server @@ -61,24 +59,19 @@ You need to know Systemd and Docker services for administrator. ### Systemd{#systemd} -Three Systemd services: **websoft9, docker, cockpit** +Websoft9 runs as a Docker container. The main Systemd service is Docker: ``` -sudo systemctl start | top | restart | status docker -sudo systemctl start | top | restart | status cockpit -sudo systemctl start | top | restart | status websoft9 +sudo systemctl start | stop | restart | status docker ``` ### Docker{#docker-services} -The **Containers** function module of the Websoft9 Console hides the Websoft9 containers, so you need to query them with the command `docker ps | grep websoft9-`. +Websoft9 runs as a single container. Query it with `docker ps | grep websoft9`: ``` -$ docker ps | grep websoft9- -8039d81eb0a1 websoft9dev/apphub:0.0.6 "/websoft9/script/en…" 32 hours ago Up 32 hours 8080-8081/tcp websoft9-apphub -cc55650540e6 websoft9dev/deployment:2.19.0 "/init_portainer" 32 hours ago Up 32 hours (healthy) 8000/tcp, 9000/tcp, 9443/tcp websoft9-deployment -527a07615809 websoft9dev/git:1.20.4 "/usr/bin/entrypoint…" 32 hours ago Up 32 hours 22/tcp, 3000/tcp websoft9-git -bbea45d00358 websoft9dev/proxy:2.10.4 "/init /bin/sh -c '/…" 32 hours ago Up 32 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 81/tcp websoft9-proxy +$ docker ps | grep websoft9 +abc123def456 websoft9dev/websoft9:latest ... Up 2 hours 0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 0.0.0.0:9000->9000/tcp websoft9 ``` ## CLI{#cli} diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-console-index.png b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-console-index.png index 5561bb7d4..777eb0c2f 100644 Binary files a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-console-index.png and b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-console-index.png differ diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-loginpage.png b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-loginpage.png index af381b603..15890129a 100644 Binary files a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-loginpage.png and b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-loginpage.png differ diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-setupwizard.png b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-setupwizard.png new file mode 100644 index 000000000..af03ad865 Binary files /dev/null and b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/assets/websoft9-setupwizard.png differ diff --git a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/login.md b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/login.md index b1f6b3528..0d173aa65 100644 --- a/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/login.md +++ b/i18n/en/docusaurus-plugin-content-docs/version-2.0/starter/login.md @@ -3,48 +3,60 @@ 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://:9000` +2. On first visit, the **Setup Wizard** will guide you to create an administrator account and configure basic settings + ![Websoft9 Setup Wizard](./assets/websoft9-setupwizard.png) +3. After setup, log in with the administrator account you just created + ![Websoft9 Login Page](./assets/websoft9-loginpage.png) -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) diff --git a/package.json b/package.json index eb655dd66..b5462e521 100644 --- a/package.json +++ b/package.json @@ -14,17 +14,16 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "^3.5.1", - "@docusaurus/plugin-client-redirects": "^3.5.1", - "@docusaurus/plugin-content-docs": "^3.5.1", - "@docusaurus/preset-classic": "^3.5.1", + "@docusaurus/core": "3.5.1", + "@docusaurus/plugin-client-redirects": "3.5.1", + "@docusaurus/plugin-content-docs": "3.5.1", + "@docusaurus/preset-classic": "3.5.1", "@mdx-js/react": "^3.0.0", "clsx": "^1.1.1", - "docusaurus-theme-search-typesense": "^0.14.1", "prism-react-renderer": "^2.1.0", - "raw-loader": "^4.0.2", "react": "^18.2.0", - "react-dom": "^18.2.0" + "react-dom": "^18.2.0", + "webpack": "5.95.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.5.1", @@ -33,6 +32,9 @@ "engines": { "node": ">=18.0" }, + "resolutions": { + "webpack": "5.95.0" + }, "browserslist": { "production": [ ">0.5%", @@ -45,4 +47,4 @@ "last 1 safari version" ] } -} +} \ No newline at end of file diff --git a/versioned_docs/version-2.0/admin/troubleshoot/faq.md b/versioned_docs/version-2.0/admin/troubleshoot/faq.md index 0c6e72b76..cfdec7b61 100755 --- a/versioned_docs/version-2.0/admin/troubleshoot/faq.md +++ b/versioned_docs/version-2.0/admin/troubleshoot/faq.md @@ -9,21 +9,6 @@ slug: /faq ## Websoft9 问题 -#### 500 Internal Server Error? - -问题描述：查看 websoft9-apphub 容器的日志，出现 500 Internal Server Error -原因分析：websoft9-apphub 容器工作异常或它与被连接的其他微服务通讯异常，运行下面的命令查看错误原因 -``` -docker exec -it websoft9-apphub cat /websoft9/apphub/logs/apphub_error.log -``` - -#### Websoft9 核心功能不可用？ - -当 Websoft9 控制台可以登录，但无法访问应用商店、容器、网关等核心功能时，最大的原因可能是网关工作异常导致应用之间的连接与集成出现了问题。 - -可运行 `docker logs websoft9-proxy` 进行诊断。 - - #### 无法访问 Websoft9 控制台？{#blank} 常见的原因如下： @@ -31,18 +16,21 @@ docker exec -it websoft9-apphub cat /websoft9/apphub/logs/apphub_error.log * 您的服务器[安全组](./security-firewall#security) **9000** 端口没有开启（**最常见因素**） * 安装的不是 Websoft9 的产品 * 你的服务器网络故障 -* Websoft9 控制台端口被重置为 **9090** * 产品本身的故障导致 -* 其他 -不管哪种原因，一旦无法出现问题，请第一时刻联系：[人工支持](./helpdesk) +不管哪种原因，一旦无法解决问题，请第一时刻联系：[人工支持](./helpdesk) -#### Cokpit 控制台端口被重置为 9090？ +#### 控制台可访问但功能异常？ -用户使用 `yum update` or `apt upgrade` 升级操作系统后，可能会导致 Cockpit 的端口被重置为 9090，怎么办？ +当 Websoft9 控制台可以登录，但无法访问应用商店、容器、网关等核心功能时，可运行以下命令进行诊断： -1. 以 9090 端口登录到 Websoft9 控制台 -2. **设置 > 系统设置** 中将端口改为 9090 +``` +# 查看 Websoft9 容器日志 +docker logs websoft9 + +# 查看容器健康状态 +docker ps --filter "name=websoft9" +``` #### Websoft9 服务无法启动？ @@ -57,29 +45,20 @@ docker exec -it websoft9-apphub cat /websoft9/apphub/logs/apphub_error.log # 查看内存使用 free -lh ``` -2. 再查看错误日志 +2. 查看 Websoft9 容器日志 ```shell - # 查看 Websoft9 服务容器日志 - docker logs websoft9-apphub - docker logs websoft9-git - docker logs websoft9-proxy - - # 查看 Websoft9 服务状态和日志 - systemctl status websoft9 - journalctl -u websoft9 + docker logs websoft9 ``` 3. 根据错误日志进行诊断 -#### Websoft9 默认端口被占用？{#portconflict} - -运行 `netstat -tunlp` 命令，查看服务器上已经使用的端口情况。 - -#### Docker service 无法启动？{#dockernotstart} - -先通过 `systemctl status docker` 和 `journalctl -xe` 查看错误日志。 - -如果错误日志是 Unit docker.socket entered failed state，表明系统缺少 docker 用户组，运行 `groupadd docker` 增加用户组 +#### 如何重置管理员密码？ +```bash +rm -f /opt/websoft9/data/config/product-auth/product-auth.sqlite +rm -f /opt/websoft9/data/config/setup-wizard/state.json +docker restart websoft9 +``` +重启后进入设置向导重新创建管理员账户。 #### 创建应用报错 `data.forward_port should be >= 1`? 问题现象：重建应用时报错 `data.forward_port should be >= 1`，但应用重建时成功的 diff --git a/versioned_docs/version-2.0/admin/troubleshoot/howto/method/tree.md b/versioned_docs/version-2.0/admin/troubleshoot/howto/method/tree.md index 17358adb2..18fc823d6 100755 --- a/versioned_docs/version-2.0/admin/troubleshoot/howto/method/tree.md +++ b/versioned_docs/version-2.0/admin/troubleshoot/howto/method/tree.md @@ -70,7 +70,7 @@ ping websoft9.com traceroute websoft9.com # Telnet -telnet websoft9.com 9090 +telnet websoft9.com 9000 # Ping 与 traceroute 组合 mtr websoft9.com diff --git a/versioned_docs/version-2.0/admin/upgrade/websoft9.md b/versioned_docs/version-2.0/admin/upgrade/websoft9.md index 3aca6da06..a545a4bcc 100755 --- a/versioned_docs/version-2.0/admin/upgrade/websoft9.md +++ b/versioned_docs/version-2.0/admin/upgrade/websoft9.md @@ -7,24 +7,22 @@ slug: /upgrade-websoft9 ## 升级 Websoft9 -Websoft9 控制台的【设置】页面提供了自动化的在线升级方案。 +安装脚本同时支持**全新安装**和**升级**，会自动检测当前环境。升级前建议先备份数据。 -也可以使用下面的一键升级脚本: ``` -wget -O install.sh https://websoft9.github.io/websoft9/install/install.sh && bash install.sh --execute_mode "upgrade" +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) diff --git a/versioned_docs/version-2.0/apps/oracle.md b/versioned_docs/version-2.0/apps/oracle.md index 056d0e82b..54a02474e 100755 --- a/versioned_docs/version-2.0/apps/oracle.md +++ b/versioned_docs/version-2.0/apps/oracle.md @@ -46,7 +46,7 @@ import Meta from './_include/oracle.md'; - 未部署 Websoft9 控制台，请 SSH 连接到服务器后，运行如下的安装命令： ``` #1 获取一键部署模板到服务器目录 /opt/oracledb - wget https://artifact.websoft9.com/release/websoft9/plugin/library/library-latest.zip && unzip -o library-latest.zip && sudo cp -rf library/apps/oracle /opt/oracledb + wget https://artifact.websoft9.com/websoft9/release/plugin/library/library-latest.zip && unzip -o library-latest.zip && sudo cp -rf library/apps/oracle /opt/oracledb #2 通过修改 .env 文件中的 W9_VERSION 的值指定目标数据库版本 diff --git a/versioned_docs/version-2.0/develop/architecture.md b/versioned_docs/version-2.0/develop/architecture.md index dd40863cd..f195c11ea 100755 --- a/versioned_docs/version-2.0/develop/architecture.md +++ b/versioned_docs/version-2.0/develop/architecture.md @@ -23,17 +23,38 @@ Websoft9 是一个以应用为中心的微服务架构模式，它入门极简 ## 架构图 -我们采用的技术要素包括：Linux, Docker, K8s, API 网关，服务发现，应用网关，应用编排，Git等。 - -对应的产品架构图如下： - -![](/img/websoft9-architecture.png) - - -- Apphub：应用管理服务，负责应用整个生命周期 -- Git：应用安装模板的仓库，实现先申明、再部署的模式 -- Deployment：负责与 Docker, K8s 交付的部署工作模块，同时提供可视化的管理容器的界面 -- App Gateway：发布和控制应用的访问 +Websoft9 采用**单容器集成控制平面**架构，所有核心服务运行在一个 Docker 容器内。 + +```mermaid +graph TB + subgraph Host["宿主机"] + subgraph Container["Websoft9 容器"] + Console["Console
React 19 + TS + MUI
:9000"] + AppHub["AppHub
Python FastAPI
/api"] + Gitea["Gitea
Git 仓库"] + Portainer["Portainer
容器管理"] + NPM["Nginx Proxy Manager
反向代理 & SSL
:80 :443"] + end + DockerSocket["Docker Socket
/var/run/docker.sock"] + DataVolumes["数据卷
/opt/websoft9/data"] + end + + User["用户浏览器"] -->|":9000"| Console + Console -->|"/api/*"| AppHub + AppHub --> Portainer + AppHub --> NPM + AppHub --> Gitea + AppHub --> DockerSocket + NPM -->|":80/:443"| Internet["外部网络"] +``` + +### 核心组件 + +- **Console**：基于 React 19 + TypeScript + Vite + MUI 构建的 Web 管理界面，通过 `9000` 端口提供服务 +- **AppHub**：基于 Python FastAPI 的业务逻辑 API，负责应用管理、认证、代理、备份等核心功能 +- **Gitea**：内嵌的 Git 仓库服务，用于托管应用模板和代码 +- **Portainer**：内嵌的容器管理服务，负责 Docker 容器和栈的生命周期管理 +- **Nginx Proxy Manager**：反向代理服务，处理域名绑定、SSL 证书管理（Let's Encrypt），绑定 `80` 和 `443` 端口 ## 开放兼容 diff --git a/versioned_docs/version-2.0/develop/cli.md b/versioned_docs/version-2.0/develop/cli.md index ae3428e94..f9f612bdf 100755 --- a/versioned_docs/version-2.0/develop/cli.md +++ b/versioned_docs/version-2.0/develop/cli.md @@ -5,22 +5,35 @@ sidebar_position: 1.2 # CLI -Websoft9 的核心微服务 AppHub 提供了一个可以管理应用的 CLI。 +Websoft9 提供了命令行工具，用于配置管理和运维操作。 -进入到 Apphub 容器的命令模式下，即可使用： +进入 Websoft9 容器即可使用： ``` -$ docker exec -it websoft9-apphub bash -$ apphub --help +$ docker exec -it websoft9 bash +$ websoft9 --help -Usage: apphub [OPTIONS] COMMAND [ARGS]... +Usage: websoft9 [OPTIONS] COMMAND [ARGS]... Options: --help Show this message and exit. Commands: - genkey Generate a new API key - getconfig Get a config value - getkey Get the API key - setconfig Set a config value + getconfig 获取配置项 + setconfig 设置配置项 + setsysconfig 设置系统配置项 + upgrade 升级应用商店资源 +``` + +### 常用示例 + +```bash +# 查看所有配置 +docker exec -it websoft9 websoft9 getconfig + +# 同步应用商店最新资源 +docker exec -it websoft9 websoft9 upgrade apps + +# 重置管理员密码（交互式输入新密码） +docker exec -it websoft9 websoft9 resetpwd ``` \ No newline at end of file diff --git a/versioned_docs/version-2.0/guide/cloud/config/huaweicloud.md b/versioned_docs/version-2.0/guide/cloud/config/huaweicloud.md index 4616a164f..278e38c5f 100644 --- a/versioned_docs/version-2.0/guide/cloud/config/huaweicloud.md +++ b/versioned_docs/version-2.0/guide/cloud/config/huaweicloud.md @@ -74,7 +74,7 @@ Websoft9 为华为云 Flexus 服务器开机即用的[专属 Websoft9 镜像](ht Websoft9 应用商店预制 phpMyAdmin，pgAdmin，CloudBeaver 等 Web 数据库管理工具。如果 Flexus 服务器内置的 Websoft9 控制台 **应用商店** 没有展现这些应用时，请通过 SSH 工具连接到服务器，运行下面的命令让它们可以被应用商店呈现： ``` -docker exec -i websoft9-apphub apphub setconfig --section initial_apps --key keys --value $(docker exec -i websoft9-apphub apphub getconfig --section initial_apps --key keys),phpmyadmin,cloudbeaver,pgadmin +docker exec -i websoft9 websoft9 setconfig --section initial_apps --key keys --value $(docker exec -i websoft9 websoft9 getconfig --section initial_apps --key keys),phpmyadmin,cloudbeaver,pgadmin ``` 接下来，就可以在应用商店安装这些工具了。 diff --git a/versioned_docs/version-2.0/guide/container/server.md b/versioned_docs/version-2.0/guide/container/server.md index e3604a66d..c327315ef 100755 --- a/versioned_docs/version-2.0/guide/container/server.md +++ b/versioned_docs/version-2.0/guide/container/server.md @@ -15,7 +15,7 @@ slug: /docker-server 如果您的服务器尚未安装 Docker，请使用如下命令安装它： ``` -wget -O - https://websoft9.github.io/websoft9/install/install_docker.sh | bash +wget -O - https://artifact.websoft9.com/websoft9/release/install_docker.sh | sudo bash ``` ### 更换默认镜像仓库{#imagespeed} diff --git a/versioned_docs/version-2.0/guide/plan/deployment.md b/versioned_docs/version-2.0/guide/plan/deployment.md index c61062b0c..bccbddff9 100755 --- a/versioned_docs/version-2.0/guide/plan/deployment.md +++ b/versioned_docs/version-2.0/guide/plan/deployment.md @@ -118,7 +118,7 @@ Websoft9 在设计的时候，充分考量了用户自主在服务器上直接 ``` # 拷贝应用清单到服务器 -docker cp websoft9-apphub:/websoft9/library /path/applibary +docker cp websoft9:/websoft9/library /path/applibary # 查看应用名录 ls /path/applibary diff --git a/versioned_docs/version-2.0/install/method/linux.md b/versioned_docs/version-2.0/install/method/linux.md index 7767c9f20..0f883a524 100755 --- a/versioned_docs/version-2.0/install/method/linux.md +++ b/versioned_docs/version-2.0/install/method/linux.md @@ -8,19 +8,19 @@ slug: /install-linux Websoft9 目前仅支持在 Linux 主机下安装。 -## 在线安装 +## 在线安装与升级 -安装 Websoft9 需要您具有操作系统的 root 权限，否则需要 *sudo su* 进行提权后再运行如下的脚本： +安装脚本同时支持**全新安装**和**升级**，会自动检测当前环境。升级前建议先备份数据。 ``` # 快速安装 -wget -O install.sh https://artifact.websoft9.com/release/websoft9/install.sh && bash install.sh +wget -O install.sh https://artifact.websoft9.com/websoft9/release/install.sh && sudo bash install.sh -# 自定义参数安装。-- channel 有 release 和 dev 两个可选项，分别代表生产版和测试版，默认值为 release -wget -O install.sh https://artifact.websoft9.com/release/websoft9/install.sh && bash install.sh --port 9000 --channel release --path "/data/websoft9/source" --version "latest" +# 自定义参数 +sudo bash install.sh --console-port 9000 --path "/data/websoft9/source" --version "latest" ``` -> 升级 Websoft9 也只需要运行上面的脚本。 +> 升级过程不会影响已部署的应用。 ## 离线安装 @@ -28,16 +28,12 @@ wget -O install.sh https://artifact.websoft9.com/release/websoft9/install.sh && ## 卸载 -Websoft9 支持[卸载](https://github.com/Websoft9/websoft9?tab=readme-ov-file#uninstall)，且卸载后不会在服务器中存留数据。 +Websoft9 支持卸载，默认**保留所有数据**。如需彻底清除，可使用 `--purge` 模式。 ``` -curl https://websoft9.github.io/websoft9/install/uninstall.sh | bash -``` - -## 安装问题 - -#### 安装成功，应用商店显示网络错误？ - -这个问题的出现的常见原因有： +# 卸载（保留数据） +curl -fsSL https://artifact.websoft9.com/websoft9/release/uninstall.sh | sudo bash -- polkit.service 无法启动会导致 Cockpit 异常 \ No newline at end of file +# 彻底清除所有数据 +sudo bash uninstall.sh --purge --yes +``` \ No newline at end of file diff --git a/versioned_docs/version-2.0/install/method/readme.md b/versioned_docs/version-2.0/install/method/readme.md index 3ea49c155..c446acf12 100755 --- a/versioned_docs/version-2.0/install/method/readme.md +++ b/versioned_docs/version-2.0/install/method/readme.md @@ -6,7 +6,7 @@ slug: /install # 安装 -Websoft9 可以在[大多数](https://websoft9.github.io/websoft9/version.json) GNU/Linux 发行版中安装，也支持各种[公有云平台](./install-cloud)和私有云技术栈。 +Websoft9 可以在[大多数](https://artifact.websoft9.com/websoft9/release/version.json) GNU/Linux 发行版中安装，也支持各种[公有云平台](./install-cloud)和私有云技术栈。 安装 Websoft9 之前，需评估性能、可靠性、易于管理（备份、升级和故障排除）以及托管成本。 diff --git a/versioned_docs/version-2.0/install/requirements.md b/versioned_docs/version-2.0/install/requirements.md index 9568e894f..ccd159bf5 100755 --- a/versioned_docs/version-2.0/install/requirements.md +++ b/versioned_docs/version-2.0/install/requirements.md @@ -17,7 +17,7 @@ title: 要求 ## 操作系统{#os} -Websoft9 支持在 Red Hat, CentOS, Debian, Ubuntu 等[主流 Linux 发行版](https://websoft9.github.io/websoft9/version.json)上安装。 +Websoft9 支持在 Red Hat, CentOS, Debian, Ubuntu 等[主流 Linux 发行版](https://artifact.websoft9.com/websoft9/release/version.json)上安装。 > 暂不支持 Windows 和 macOS 等操作系统 @@ -30,9 +30,7 @@ Websoft9 支持[全局域名](./domain-set#wildcard)。它一次设置后，所 ## 软件 -Python 是安装 Websoft9 的必选项，所需版本：Python 3.8 以上 + pip。 - -其他组件均通过在线安装脚本自动安装。 +安装脚本会自动处理所需依赖（Docker 等），无需手动安装额外软件。 ## 客户端浏览器 diff --git a/versioned_docs/version-2.0/reference/parameter.md b/versioned_docs/version-2.0/reference/parameter.md index 5ce0c343a..556d9da08 100755 --- a/versioned_docs/version-2.0/reference/parameter.md +++ b/versioned_docs/version-2.0/reference/parameter.md @@ -11,11 +11,9 @@ Websoft9 所涉及的服务器、网络、端口和路径等各种参数如下 Websoft9 控制台相关目录以及路径说明如下： -- **Websoft9 安装配置目录**：*/data/websoft9/source* -- **Websoft9 容器编排文件目录**：*/data/websoft9/source/docker* -- **Websoft9 系统配置目录**：*/opt/websoft9* -- **Websoft9 插件目录**： */usr/share/cockpit* -- **Websoft9 备份目录**： */data/websoft9/vl_backup* +- **Websoft9 安装目录**：*/opt/websoft9* +- **Websoft9 数据持久化目录**：*/opt/websoft9/data* +- **Websoft9 备份目录**： */opt/websoft9/data/backups* - **Websoft9 应用持久化存储目录**： */var/lib/docker/volumes* Docker 相关的目录： @@ -60,24 +58,19 @@ Docker 相关的目录： ### Systemd 服务{#systemd} -包含：websoft9, docker, cockpit 三个 Systemd 服务： +Websoft9 以 Docker 容器方式运行，涉及的 Systemd 服务主要是 Docker： ``` -sudo systemctl start | top | restart | status docker -sudo systemctl start | top | restart | status cockpit -sudo systemctl start | top | restart | status websoft9 +sudo systemctl start | stop | restart | status docker ``` ### Docker 服务{#docker-services} -Websoft9 控制台的**容器管理界面**隐藏了对 Websoft9 容器的管理。故，通过 `docker ps | grep websoft9-` 命令查询： +Websoft9 以单容器方式运行，通过 `docker ps | grep websoft9` 命令查询： ``` -$ docker ps | grep websoft9- -8039d81eb0a1 websoft9dev/apphub:0.0.6 "/websoft9/script/en…" 32 hours ago Up 32 hours 8080-8081/tcp websoft9-apphub -cc55650540e6 websoft9dev/deployment:2.19.0 "/init_portainer" 32 hours ago Up 32 hours (healthy) 8000/tcp, 9000/tcp, 9443/tcp websoft9-deployment -527a07615809 websoft9dev/git:1.20.4 "/usr/bin/entrypoint…" 32 hours ago Up 32 hours 22/tcp, 3000/tcp websoft9-git -bbea45d00358 websoft9dev/proxy:2.10.4 "/init /bin/sh -c '/…" 32 hours ago Up 32 hours 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp, 81/tcp websoft9-proxy +$ docker ps | grep websoft9 +abc123def456 websoft9dev/websoft9:latest ... Up 2 hours 0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp, 0.0.0.0:9000->9000/tcp websoft9 ``` ## 命令行 diff --git a/versioned_docs/version-2.0/starter/assets/websoft9-console-index.png b/versioned_docs/version-2.0/starter/assets/websoft9-console-index.png index ed32817d8..c8efc48ea 100644 Binary files a/versioned_docs/version-2.0/starter/assets/websoft9-console-index.png and b/versioned_docs/version-2.0/starter/assets/websoft9-console-index.png differ diff --git a/versioned_docs/version-2.0/starter/assets/websoft9-loginpage.png b/versioned_docs/version-2.0/starter/assets/websoft9-loginpage.png index 5bec2a68d..e638e30ef 100644 Binary files a/versioned_docs/version-2.0/starter/assets/websoft9-loginpage.png and b/versioned_docs/version-2.0/starter/assets/websoft9-loginpage.png differ diff --git a/versioned_docs/version-2.0/starter/assets/websoft9-setupwizard.png b/versioned_docs/version-2.0/starter/assets/websoft9-setupwizard.png new file mode 100644 index 000000000..3b25fea27 Binary files /dev/null and b/versioned_docs/version-2.0/starter/assets/websoft9-setupwizard.png differ diff --git a/versioned_docs/version-2.0/starter/login.md b/versioned_docs/version-2.0/starter/login.md index 2d24e75c8..61d1e1881 100644 --- a/versioned_docs/version-2.0/starter/login.md +++ b/versioned_docs/version-2.0/starter/login.md @@ -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)