Skip to content

Commit

Permalink
fix template
Browse files Browse the repository at this point in the history
  • Loading branch information
chendelin1982 authored Nov 11, 2024
1 parent d8a19a1 commit cbeb368
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 34 deletions.
56 changes: 33 additions & 23 deletions docs/apps/redmine.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,29 +22,39 @@ import Meta from './_include/redmine.md';

### 管理插件

获取匹配的插件版本后,将插件下载解压到 Redmine 容器目录 */usr/src/redmine/plugins* 中,重启 Redmine 容器后生效
获取匹配的插件版本后,两个步骤即可安装插件

#### 安装插件
1. 将插件下载解压(或 git clone)到 Redmine 容器目录 */usr/src/redmine/plugins*
2. 重启 Redmine 容器后生效

容器内下载解压插件的命令范例:
```
apt update -y && apt install unzip
curl -L -o plugin_name.zip https://url/plugin_name.zip
unzip rplugin_name.zip -d /usr/src/redmine/plugins
```
> 插件版本不匹配会导致容器无法启动,需立即删除插件
#### 删除插件
#### 下载插件范例

```
# 下载并解压插件
apt update -y && apt install unzip
curl -L -o plugin_name.zip https://url/plugin_name.zip
unzip plugin_name.zip -d /usr/src/redmine/plugins
# git clone 插件
cd /usr/src/redmine/plugins
git clone https://github.com/Ilogeek/redmine_issue_dynamic_edit.git
```

删除插件目录即卸载插件
#### 卸载插件

删除插件目录,即卸载插件

#### 迁移插件

Redmine 官方文档表示[升级 Redmine](https://www.redmine.org/projects/redmine/wiki/RedmineUpgrade) 时,需要将插件目录移动到其他位置作为备份。待 Redmine 升级成功后,方可将插件逐一拷贝到插件目录。
如果 Redmine 容器中的插件目录已经挂载到宿主机,那么[升级 Redmine](https://www.redmine.org/projects/redmine/wiki/RedmineUpgrade) 时,插件可能无法适用新的 Redmine 版本而导致 Redmine 升级失败。

Redmine 插件的 ruby 版本以及 gem 包依赖可能会与 Redmine 主程序产生冲突,导致 Redmine 无法启动。

其原因是 Redmine 插件的 ruby 版本以及 gem 包依赖可能会与 Redmine 主程序产生冲突,导致 Redmine 无法启动
因此,Websoft9 标准的 Redmine 启动程序并没有将容器中的插件目录挂载到宿主机

因此,Websoft9 标准的 Redmine 启动程序并没有将容器中的插件目录挂载到宿主机。
正确的做法是:在升级 Redmine 之前,需要将插件目录移动到其他位置作为备份,待 Redmine 升级成功后,方可将插件逐一拷贝到插件目录。


### 设置 SMTP{#smtp}
Expand All @@ -55,16 +65,16 @@ Redmine 官方文档表示[升级 Redmine](https://www.redmine.org/projects/redm
- 注意缩进/空格,否则 Redmine 报错
```
production:
delivery_method: :smtp
smtp_settings:
address: smtp.exmail.qq.com
port: 465
ssl: true
enable_starttls_auto: true
domain: websoft9.com
authentication: :login
user_name: [email protected]
password: ********
delivery_method: :smtp
smtp_settings:
address: smtp.exmail.qq.com
port: 465
ssl: true
enable_starttls_auto: true
domain: websoft9.com
authentication: :login
user_name: [email protected]
password: ********
```
2. 重启 Redmine 容器后生效
Expand Down
20 changes: 10 additions & 10 deletions i18n/en/docusaurus-plugin-content-docs/current/apps/redmine.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,16 +51,16 @@ If Redmine upgrade successful, you can move plugins to container one by one.
2. Modify the `.src/configuration. yml` file at git repository and add below SMTP configurations at **production**:
```
production:
delivery_method: smtp
smtp_settings:
address: smtp.exmail.qq.com
port: 465
ssl: true
enable_starttls_auto: true
domain: websoft9.com
authentication: :login
user_name: [email protected]
password: ********
delivery_method: smtp
smtp_settings:
address: smtp.exmail.qq.com
port: 465
ssl: true
enable_starttls_auto: true
domain: websoft9.com
authentication: :login
user_name: [email protected]
password: ********
```
2. It works after restarting the Redmine container
3. Redmine Console Settings for SMTP: **Administration > Configuration > Email Notification**
Expand Down
6 changes: 6 additions & 0 deletions template/meta/en.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@

When referring to this document to use **{{ trademark }}**, please read and ensure the following points:

- [Login to Websoft9 Console](./login-console) and find or install {{ trademark }}:
- Go to **My Apps** listing applications
- Go to **App Store** installing target application

- This application is installed by Websoft9 console.

{% if license %}
- The purpose of this application complies with the [{{ license.key }}]({{license.url}}) open source license agreement.
{% else %}
- Please check the application's usage license agreement to ensure compliance.
{% endif %}

- [Configure the domain name](./domain-set) or **server security group** opens external network ports for application access.
8 changes: 7 additions & 1 deletion template/meta/zh.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,16 @@

在参阅本文档使用 {{ trademark }} 时,需要确保如下几点:

- [登录 Websoft9 控制台](./login-console),然后找到(或安装){{ trademark }}:
- **我的应用** 菜单找到应用
- **应用商店** 菜单部署应用

- 应用是基于 Websoft9 安装的
{% if license %}

- 应用的用途符合 [{{ license.key }}]({{license.url}}) 开源许可协议
{% else %}
- 请检查应用的使用许可协议,确保符合要求
{% endif %}
- 应用具备访问条件:[配置域名](./domain-set) 或 **服务器安全组**开启网外端口

- 为应用准备配置访问方式:[配置域名](./domain-set) 或 **服务器安全组**开启网外端口

0 comments on commit cbeb368

Please sign in to comment.