Browse Source

docs update

master
filesite 2 months ago
parent
commit
69fe789973
  1. 2
      FAQ.md
  2. 8
      themes/README.md
  3. 139
      www/content/Machete_Doc.md
  4. 3
      www/content/Manual.md
  5. 2
      www/content/README.md
  6. 2
      www/content/en/README.md

2
FAQ.md

@ -56,7 +56,7 @@ Filesite/machete是**开放源代码**的,它托管在以下几个git网站:
这样基于docker提供的安全沙箱环境,最大程度地保护你的电脑、服务器不受machete程序影响。 这样基于docker提供的安全沙箱环境,最大程度地保护你的电脑、服务器不受machete程序影响。
最后,machete程序只有临时文件存放目录runtime/需要开放**写入权限**,其它文件和目录都只需开放“只读”权限即可, 最后,machete程序只有临时文件存放目录runtime/需要开放**写入权限**,其它文件和目录都只需开放“只读”权限即可,
所以你在使用docker为machete配置volume或者本地映射目录时,相册目录只开放只读权限docker容器, 所以你在使用docker为machete配置volume或者本地映射目录时,相册目录只开放只读权限docker容器,
由此可以进一步确保你的照片目录不会被machete程序修改/删除。 由此可以进一步确保你的照片目录不会被machete程序修改/删除。

8
themes/README.md

@ -10,10 +10,10 @@
## 示例 ## 示例
皮肤名:**night**,默认首页SiteController使用的视图名:**site**, 皮肤名:**beauty**,默认首页SiteController使用的视图名:**site**,
其目录结构为: 其目录结构为:
``` ```
night/controller/SiteController.php beauty/controller/SiteController.php
night/views/layout/main.php beauty/views/layout/main.php
night/views/site/index.php beauty/views/site/index.php
``` ```

139
www/content/Machete_Doc.md

@ -2,40 +2,39 @@
![Filesite.io - Machete](./machete_icon.png) ![Filesite.io - Machete](./machete_icon.png)
Markdown及其编辑器的普及,以及类似Jekyll以文件为基础的博客系统的出现,为博主们提供了一种更为专注的写作方式, **Markdown**及其编辑器的普及,以及类似Jekyll**以文件为基础**的博客系统的出现,为博主们提供了一种**更为专注**的写作方式,
在自己的电脑本地且不必联网的情况下就能创作,不再依赖于像WordPress这类系统后台。 在自己的电脑本地且不必联网的情况下就能创作,不再依赖于像WordPress这类系统后台。
对于喜欢写作的创作者们,显然已经从Markdown的使用中由原来的在线编辑转为本地编辑获得了更高的自由度和效率, 对于喜欢写作的创作者们,显然已经从Markdown的使用中由原来的在线编辑转为本地编辑获得了更高的自由度和效率,
除了博客,放眼到其它行业,基于文件、目录就能管理内容的典型还有代码托管(如Github)、网盘和云存储(如iCloud), 除了博客,放眼到其它行业,基于文件、目录就能管理内容的典型还有代码托管(如Github)、网盘和云存储(如iCloud),
那我们何不把这个成功的经验推广到更多的内容创作领域,如:小说、摄影、播客,帮助创作者简化将内容制作成网站的工作, 那我们何不把这个成功的经验推广到更多的内容创作领域,如:小说、摄影、播客,帮助创作者简化将内容制作成网站的工作,
于是FileSite.io诞生了。 于是**FileSite.io**诞生了。
## 愿景 ## 愿景
**进一步降低**内容分享者、创作者把内容变成网站的**门槛**, **进一步降低内容分享者、创作者把内容变成网站的门槛**,
以常见的本地磁盘目录+文件的形式作为网站数据来源, 以常见的本地磁盘目录+文件的形式作为网站数据来源,
修改磁盘文件内容上传到服务器就可以生成网页, 修改磁盘文件内容上传到服务器就可以生成网页,
让大家更易于同时维护本地和网站的内容。 让大家更易于同时维护本地和网站的内容。
FileSite.io希望帮助到他们: FileSite.io希望帮助到他们:
* 经常用Markdown写文档/文章的朋友
* 网址导航站经营者、收藏夹/网址分享者
* 小说网站经营者、小说创作者、博客主、作家、自媒体人
* 图片网站经营者、摄影师、摄影爱好者、驴友 * 图片网站经营者、摄影师、摄影爱好者、驴友
* 视频网站经营者、播客、摄影师、航拍爱好者、运动爱好者、潜水爱好者 * 视频网站经营者、播客、摄影师、航拍爱好者、运动爱好者、潜水爱好者
* 经常用Markdown写文档/文章的朋友
* 网址导航站经营者、收藏夹/网址分享者
## Docker使用视频教程 ## Docker使用视频教程
在Docker中如何用filesite/machete源码快速搭建支持文件共享方式管理内容的图片网站、视频网站、导航网站和文档站的视频教程。 在Docker中如何用filesite/machete源码快速搭建支持文件/目录管理内容的图片网站、视频网站、导航网站和文档站的视频教程。
主要步骤: 主要步骤:
1. docker pull filesite/machete 1. docker pull filesite/machete
2. docker run ... 2. docker run ...
3. 本地测试网站和后台 3. 本地测试网站和后台
4. 在docker容器中升级最新版 4. 在docker容器中升级最新版
5. 如何在macos中挂载远程磁盘来管理图片等内容 5. <del>如何在macos中挂载远程磁盘来管理图片等内容</del>(samba版不再维护,如有需要请自行研究)
视频教程: 视频教程:
@ -50,19 +49,9 @@ FileSite.io希望帮助到他们:
Machete使用非常简单,一旦部署好之后,以后只需将本地最新内容上传覆盖即可。 Machete使用非常简单,一旦部署好之后,以后只需将本地最新内容上传覆盖即可。
1. 下载Machete源码,并参考[Nginx配置示例](./Nginx.conf.md)部署到你的服务器上 1. 参考上面“Docker使用视频教程“下载、安装Machete;
说明: 也支持手动部署,请参考Machete源码根目录下的README.md文档。
Machete不支持子目录方式访问,需要为nginx配置根目录指向代码目录下的www/。
用git下载:
```
git clone https://git.filesite.io/filesite/machete.git
```
或下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)):
```
https://git.filesite.io/filesite/machete/archive/master.zip
```
2. 修改配置文件``config/app.php``,简单设置后上传到服务器完成部署; 2. 修改配置文件``config/app.php``,简单设置后上传到服务器完成部署;
@ -74,49 +63,23 @@ https://git.filesite.io/filesite/machete/archive/master.zip
3. 将本地内容目录及文件上传到网站目录:``www/content/`` 3. 将本地内容目录及文件上传到网站目录:``www/content/``
不同皮肤请上传到对应的目录,详情参考Machete源码Readme 不同皮肤请上传到对应的目录,详情参考Machete源码README.md文档
4. 打开网址浏览最新内容; 4. 打开网址浏览最新内容;
有了Machete,你可以保留现有的本地内容创作习惯,并非常容易地把它们制作成一个网站分享给他人。 有了Machete,你可以**保留现有的本地内容创作习惯**,并非常容易地把它们制作成一个网站分享给他人。
## 在线体验 ## 在线体验
Machete是单入口模式PHP源码,**不支持子目录方式访问**,以下示例都是以子域名或根域名配置nginx根目录指向代码目录下的www/index.php。 Machete是单入口模式PHP源码,**不支持子目录方式访问**,以下示例都是以子域名或根域名配置nginx根目录指向代码目录下的www/index.php。
1. 文档站 | 类型 | 名称 | 网址 |
| ---- | ---- | ---- |
| 名称 | 网址 | | 图片站 | 家庭相册演示 | <a href="https://demo.jialuoma.cn" target="_blank">Demo</a> |
| ---- | ---- | | 视频分享站 | Ta荐 | <a href="https://tajian.tv" target="_blank">TaJian.tv</a> |
| FileSite | <a href="https://filesite.io" target="_blank">Filesite.io</a> | | 文档站 | FileSite | <a href="https://filesite.io" target="_blank">Filesite.io</a> |
| 导航站 | 站长手册 | <a href="https://webdirectory.filesite.io" target="_blank">WebDir</a> |
2. 导航站
| 名称 | 网址 |
| ---- | ---- |
| 站长手册 | <a href="https://webdirectory.filesite.io" target="_blank">WebDirectory.FileSite.io</a> |
| Web3速查手册 | <a href="https://web3.filesite.io" target="_blank">Web3.FileSite.io</a> |
3. 图片站
| 名称 | 网址 |
| ---- | ---- |
| 看美女 | <a href="https://googleimage.filesite.io" target="_blank">GoogleImage.Filesite.io</a> |
| 在线演示 | <a href="https://demo.jialuoma.cn" target="_blank">带后台版Machete在线演示</a> |
4. 视频站
| 名称 | 网址 |
| ---- | ---- |
| 在线学 | <a href="https://duan.filesite.io" target="_blank">Duan.Filesite.io</a> |
5. 视频收藏/分享站
| 名称 | 网址 |
| ---- | ---- |
| Ta荐 | <a href="https://tajian.tv" target="_blank">TaJian.tv</a> |
## 源码下载 ## 源码下载
@ -129,26 +92,21 @@ Filesite.io也一样,它短小精悍,使用它把常见的本地文件制作
点击下面网址查看源码或者下载源码: 点击下面网址查看源码或者下载源码:
* 查看<a href="https://git.filesite.io/filesite/machete" target="_blank">FileSite.io源码Machete</a> * 查看<a href="https://github.com/filesite-io/machete" target="_blank">FileSite-io/Machete</a>
* 用git下载: * 用git下载:
``` ```
git clone https://git.filesite.io/filesite/machete.git git clone https://github.com/filesite-io/machete.git
``` ```
* 下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)): * 下载zip压缩包([点我直接下载](https://github.com/filesite-io/machete/archive/refs/heads/main.zip)):
``` ```
https://git.filesite.io/filesite/machete/archive/master.zip https://github.com/filesite-io/machete/archive/refs/heads/main.zip
``` ```
* 从Docker Hub下载镜像: * 从Docker Hub下载镜像:
``` ```
docker pull filesite/machete docker pull filesite/machete
```
支持samba文件共享管理内容的版本:
```
docker pull filesite/machete:samba
``` ```
启动容器: 启动容器:
@ -156,63 +114,26 @@ docker pull filesite/machete:samba
docker run --name machete -p 1080:80 -itd filesite/machete docker run --name machete -p 1080:80 -itd filesite/machete
``` ```
samba文件共享版本容器启动:
```
docker run --name machete_samba -p 1081:80 -p 445:445 -itd filesite/machete:samba
```
文件共享挂载远程目录默认账号密码:
> 账号:filesite
> 密码:88888888
在浏览器打开本地网址预览:
```
http://127.0.0.1:1080
```
samba文件共享版本本地网址访问:
```
http://127.0.0.1:1081
```
* 基于Vue的文件目录管理后台源码
<a href="https://github.com/filesite-io/admin-vue" target="_blank">去Github下载</a> (海外推荐使用)
<a href="https://gitcode.net/filesite/admin-vue" target="_blank">去Gitcode下载</a> (国内推荐使用)
更多使用说明见Machete源码README.md。 更多使用说明见Machete源码README.md。
## 皮肤下载 ## 皮肤介绍
FileSite.io官方提供的皮肤都包含在最新版的源码目录```themes/```中,详情如下: FileSite.io官方提供的皮肤都包含在最新版的源码目录```themes/```中,详情如下:
| 皮肤名称 | 皮肤目录 | 适用网站类型 | | 皮肤名称 | 皮肤目录 | 适用网站类型 |
| ---- | ---- | ---- | | ---- | ---- | ---- |
| Beauty | beauty | 图片站 |
| TaJian | tajian | 视频分享站 |
| WebDirectory | webdirectory | 导航站 | | WebDirectory | webdirectory | 导航站 |
| Manual | manual | 文档站 | | Manual | manual | 文档站 |
| GoogleImage | googleimage | 图片站 | | GoogleImage | googleimage | 图片站 |
| Beauty | beauty | 图片站 |
| VideoBlog | videoblog | 视频站 | | VideoBlog | videoblog | 视频站 |
官方皮肤介绍如下:
* [导航站皮肤WebDirectory](./Theme_WebDirectory.md)
* [文档站皮肤Manual](./Theme_Manual.md)
* [图片站皮肤GoogleImage](./Theme_GoogleImage.md)
* [图片站皮肤Beauty](./Theme_Beauty.md)
* [视频站皮肤VideoBlog](./Theme_VideoBlog.md)
**说明**:
第三方提供的皮肤下载: 目前以图片站、视频分享站为主,其它几个类型暂停维护。
| 皮肤名称 | 目录名 | 适用网站类型 | 下载地址 |
| ---- | ---- | ---- | ---- |
| - | - | - | - |
如果你基于Machete开发了皮肤想要共享给大家使用,请在联系我们提交下载地址。
## 使用手册 ## 使用手册
@ -245,9 +166,5 @@ FileSite.io二次开发参考:
## 联系我们 ## 联系我们
加入QQ群: 请打开官方网站查看底部QQ群和微信:
<a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">网址导航、图片、视频网站交流群</a> <a href="https://filesite.io" target="_blank">FileSite.io</a>
扫码加微信好友:
<img src="./wx_jialuoma.jpeg" alt="扫描微信二维码加好友" width="240" />

3
www/content/Manual.md

@ -342,7 +342,8 @@ URL=https://microsoft.com/
### 皮肤设计规范 ### 皮肤设计规范
-- 待完善
### 皮肤共享提交 ### 皮肤共享提交
-- 待完善

2
www/content/README.md

@ -183,7 +183,7 @@ https://github.com/filesite-io/machete/
* 加入QQ群: * 加入QQ群:
<a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">网址导航、图片、视频网站交流群</a> <a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">Machete图片、视频源码交流群:44123711</a>
* 扫码加微信好友: * 扫码加微信好友:

2
www/content/en/README.md

@ -188,7 +188,7 @@ [email protected]
* Join QQ group: * Join QQ group:
<a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">Website navigation, picture, video website exchange group</a> <a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">QQ group of Filesite/Machete: 44123711</a>
* Scan the QR code to add WeChat friends: * Scan the QR code to add WeChat friends:

Loading…
Cancel
Save