The docs from 1panel-dev

docs's Introduction

本仓库保存了 1Panel 项目的官方文档，该文档使用 MkDocs 文档框架下的 Material for MkDocs 主题进行构建。

本地开发

克隆本仓库

git clone https://github.com/1Panel-dev/docs.git

安装依赖

cd docs
pip install -r requirements/requirements.txt

修改文档内容

本文档的文档结构定义在 mkdocs.yml 文件中，文档的具体内容均在 docs 目录中。

文档内容使用 markdown 语法编写，若要添加新的文档，需要先在 mkdocs.yml 文件中的 nav 部分增加对应章节导航。

本地调试文档

mkdocs serve

执行上述命令后，可通过 http://127.0.0.1:8000 地址查看生成的文档内容，当修改文档后，页面内容会自动更新。

构建文档

mkdocs build

执行上述命令后，会在 site 目录下生成文档站点的静态文件，将目录中的内容复制到任意 HTTP 服务器上即可完成文档的部署。

问题反馈

如果您发现文档中存在错误，或对文档内容存在疑问，请提交 GitHub Issue 到 1Panel 项目的主仓库

docs's People

Contributors

Stargazers

Watchers

docs's Issues

FTP 里面的软连接错了

装完没有 /etc/pure-ftpd/pureftpd.pdb 我以为是这个的问题～

文档描述问题 / 文档与面板提示不一致

在文档的计划任务 - 5 备份目录部分提到

支持设置排除文件，但是系统要求必须以英文分号隔开，如*.log;*.sql;

但是我使用 *.ogg;*.mp3;*.flac;*.lrc 的格式填写排除类型时，报错

[2023-12-30 14:40:56] [INFO] start to handle remove expired, retain copies: 0  
[2023-12-30 14:46:49] [INFO] add directory job data备份 successful  
[2023-12-30 14:46:49] [INFO] start cronjob entryID: 9  
[2023-12-30 14:46:56] [INFO] start to backup directory data备份 to OneDrive  
[2023-12-30 14:46:56] [INFO] handle tar /opt/1panel/backup/directory/data备份 to directory_data_20231230144656.tar.gz  
[2023-12-30 14:46:56] [DEBUG] tar --warning=no-file-changed --ignore-failed-read -zcf /opt/1panel/backup/directory/data备份/directory_data_20231230144656.tar.gz  --exclude *.ogg;*.mp3;*.flac;*.lrc; --exclude *.sock -C / data  
[2023-12-30 14:46:56] [ERROR] do handle tar failed, stdout: stderr: tar: Cowardly refusing to create an empty archive
Try 'tar --help' or 'tar --usage' for more information.
bash: line 1: *.mp3: command not found
bash: line 1: *.flac: command not found
bash: line 1: *.lrc: command not found
bash: line 1: --exclude: command not found
, err: exit status 127

而我改用一行一个时，备份正常运行

*.ogg
*.mp3
*.flac
*.lrc

正常运行日志

[2023-12-30 14:49:06] [INFO] add directory job data备份 successful  
[2023-12-30 14:49:06] [INFO] start cronjob entryID: 10  
[2023-12-30 14:49:09] [INFO] start to backup directory data备份 to OneDrive  
[2023-12-30 14:49:09] [INFO] handle tar /opt/1panel/backup/directory/data备份 to directory_data_20231230144909.tar.gz  
[2023-12-30 14:49:09] [DEBUG] tar --warning=no-file-changed --ignore-failed-read -zcf /opt/1panel/backup/directory/data备份/directory_data_20231230144909.tar.gz  --exclude *.ogg --exclude *.mp3 --exclude *.flac --exclude *.lrc --exclude *.sock -C / data  
[2023-12-30 14:50:18] [INFO] start to handle remove expired, retain copies: 7

updata：才发现面板有提示，与文档内容不一样

Recommend Projects