Skip to content

Commit

Permalink
Templating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
qiaofeng1227 authored and github-actions[bot] committed Apr 8, 2023
1 parent 497c56e commit 0a40eaa
Show file tree
Hide file tree
Showing 8 changed files with 304 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/apps/create/apitable/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
position: 100
label: "APITable"
collapsible: true
collapsed: true
className: "red"
34 changes: 34 additions & 0 deletions docs/apps/create/apitable/admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
sidebar_position: 3
slug: /apitable/admin
tags:
- 故障
- 路径
---


# 维护指南

本章提供的是本应用自身特殊等维护与配置。而**配置域名、HTTPS设置、数据迁移、应用集成、Web Server 配置、Docker 配置、修改数据库连接、服务器上安装更多应用、操作系统升级、快照备份**等操作通用操作请参考:[管理员指南](../administrator)[安装后配置](../install/setup) 相关章节。

## 场景

### APITable 备份与恢复

### APITable 升级

## 故障排除{#troubleshoot}

除以下列出的 APITable 故障问题之外, [通用故障处理](../troubleshoot) 专题章节提供了更多的故障方案。

#### 更改域名导致无法访问 APITable ?

#### 访问 APITable 出现 502 错误?{#502}


## 问题解答{#faq}

#### APITable 支持多语言吗?

支持多语言(包含中文),通过控制台即可修改语言

109 changes: 109 additions & 0 deletions docs/apps/create/apitable/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
sidebar_position: 100
slug: /apitable
tags:
- Web 面板
- 可视化
- GUI
---

# 快速入门

APITable 介绍

部署 Websoft9 提供的 APITable 之后,请参考下面的步骤快速入门。

## 准备{#prepare}

1. 在云控制台获取您的 **服务器公网IP地址**
2. 在云控制台安全组中,确保 **Inbound(入)规则** 下的 **TCP:80** 端口已经开启
3. 在服务器中查看 APITable 的 **[默认账号和密码](./user/credentials)**
4. 若想用域名访问 APITable,务必先完成 **[域名五步设置](./administrator/domain_step)** 过程

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

### 详细步骤

1. 使用本地电脑浏览器访问网址:*http://域名* 或 *http://服务器公网IP*, 进入初始化页面

2. 完成初始化工作

### 碰到问题?

若碰到问题,请第一时刻联系 **[技术支持](./helpdesk)**。也可以先参考下面列出的问题定位或 **[FAQ](./faq#setup)** 尝试快速解决问题。

**APITable 能打开,但总是出现 502 错误?**

参阅:

## APITable 使用入门{#quickstart}

下面以 **××××** 作为一个任务,帮助用户快速入门:

## APITable 常用操作{#guide}

### 配置 SMTP{#smtp}

1. 在邮箱管理控制台获取 [SMTP](./administrator/smtp) 相关参数

2. 填写 APITable 邮件相关配置

3. 测试邮件发送是否可用

### 安装插件{#plugin}

### 重置管理员密码{#resetpw}

忘记管理员密码时,请参考如下方案重置密码:

### 域名额外配置(修改 URL){#dns}

**[域名五步设置](./administrator/domain_step)** 完成后,需设置 APITable 的 URL:

1. 步骤1

2. 步骤2

### HTTPS 额外设置{#https}

**[标准 HTTPS 配置](./administrator/domain_https)** 完成后,可能还需要如下步骤:

1. 步骤1

2. 步骤2

## APITable 参数{#parameter}

APITable 应用中包含 Docker, Portainer 等组件,可通过 **[通用参数表](./administrator/parameter)** 查看路径、服务、端口等参数。

通过运行 `docker ps`,查看 APITable 运行时所有的服务组件:

```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
```

### 路径{#path}

APITable 配置文件: *path/config.php*

### 端口{#port}

除 80, 443 等常见端口需开启之外,以下端口可能会用到:

| 端口号 | 用途 | 必要性 |
| ------ | --------------------------------------------- | ------ |
| 8080 | APITable 原始端口,已通过 Nginx 转发到 80 端口 | 可选 |

### 版本{#version}

控制台查看

### 服务{#service}

```shell
sudo docker start | stop | restart | stats apitable
```

### 命令行{#cli}

### API{#api}
13 changes: 13 additions & 0 deletions docs/apps/create/apitable/solution.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 2
slug: /apitable/solution
tags:
- 集成
- 场景
---

# 场景方案

APITable 可以与其他的软件平台**集成**一起使用,适用于各种业务场景。


Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
position: 100
label: "APITable"
collapsible: true
collapsed: true
className: "red"
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_position: 3
slug: /apitable/admin
tags:
- APITable
---


# APITable Maintenance

This chapter is special guide for APITable maintenance and settings. And you can refer to [Administrator](../administrator) and [Steps after installing](../install/setup) for some general settings that including: **Configure Domain, HTTPS Setting, Migration, Web Server configuration, Docker Setting, Database connection, Backup & Restore...**

## Maintenance guide

### APITable Backup and Restore

### APITable Upgrade

## Troubleshoot{#troubleshoot}

In addition to the APITable issues listed below, you can refer to [Troubleshoot + FAQ](../troubleshoot) to get more.

## FAQ{#faq}

#### APITable support multi-languages?

Yes


Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
sidebar_position: 100
slug: /apitable
tags:
- APITable
---

# APITable Getting Started

APITable introduce

If you have installed Websoft9 APITable, the following steps is for your quick start

## Preparation

1. Get the **Internet IP** of your Server on Cloud
2. Check your **[Inbound of Security Group Rule](./administrator/firewall#security)** of Cloud Console to ensure the **TCP:80** is allowed
3. Connect your Server and get **[default username and password](./user/credentials)** of APITable
4. Complete **[Five steps for Domain](./administrator/domain_step)** if you want to use Domain for APITable

## APITable Initialization

### Steps for you

1. Using local browser to visit the URL *http://DNS* or *http://Server's Internet IP*, you will enter initial wizard of APITable

2. Complete initialization

3. login to your APITable([Don't have password?](./user/credentials))

### Having trouble?

Below is for you to solve problem, and you can contact **[Websoft9 Support](./helpdesk)** or refer to **[Troubleshoot + FAQ](./faq#setup)** to get more.

**APITable interface 502 error?**

Refer to:

## APITable QuickStart

This task **xxxx** is for your APITable QuickStart

1.

2.

## APITable Setup

### Configure SMTP{#smtp}

1. Prepare your [SMTP parameter](./administrator/smtp)

2. Start to configure APITable

3. Test it

### DNS Additional Configure{#dns}

Complete **[Five steps for Domain](./administrator/domain_step)** ,Set the URL for APITable

1. step1

2. step2

## Reference sheet

The below items and **[General parameter sheet](./administrator/parameter)** is maybe useful for you manage APITable

Run `docker ps`, view all containers when APITable is running:

```bash
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
```

### Path{#path}

APITable configuration file: *path/config.php*

### Port{#port}

In addition to common ports such as 80, 443, etc., the following ports may be used:

| Port | Use | Necessity |
| ------ | --------------------------------------------- | ------ |
| 8080 | APITable original port | Optional |

### Version {#version}

View in console

### Service {#service}

```shell
sudo docker start | stop | restart | stats apitable
```

### CLI {#cli}

### API {#api}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 2
slug: /apitable/solution
tags:
- APITable
---

# APITable Solution

You can use [APITable](https://www.jenkins.io/solutions/) integrated other software for **xxxx**.

0 comments on commit 0a40eaa

Please sign in to comment.