Browse Source

Readme update

master
filesite 2 years ago
parent
commit
7ed208b05b
  1. 2
      www/content/Manual.md
  2. 2
      www/content/Nginx.conf.md
  3. 59
      www/content/README.md

2
www/content/Manual.md

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
# filesite.io使用手册
# FileSite.io使用手册
## 目录和文件说明

2
www/content/Nginx.conf.md

@ -1,4 +1,4 @@ @@ -1,4 +1,4 @@
# Nginx config example
# Nginx config example of FileSite.io
* Domain: `fsc.org`
* Web directory: `/var/www/fscphp/www/`

59
www/content/README.md

@ -1,4 +1,4 @@ @@ -1,4 +1,4 @@
# filesite.io - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统
# FileSite.io - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统
![Filesite.io - Machete](./machete_icon.png)
@ -41,6 +41,7 @@ git clone https://git.filesite.io/filesite/machete.git @@ -41,6 +41,7 @@ git clone https://git.filesite.io/filesite/machete.git
```
https://git.filesite.io/filesite/machete/archive/master.zip
```
2. 修改配置文件``config/app.php``,简单设置后上传到服务器完成部署;
指定内容目录和使用的皮肤:
@ -48,7 +49,11 @@ https://git.filesite.io/filesite/machete/archive/master.zip @@ -48,7 +49,11 @@ https://git.filesite.io/filesite/machete/archive/master.zip
'content_directory' => 'content/', //内容存放目录
'theme' => 'manual', //皮肤名称,如:文档站选manual,图片站选googleimage
```
3. 将本地内容目录及文件上传到网站目录:``www/content/``
不同皮肤请上传到对应的目录,详情参考Machete源码Readme。
4. 打开网址浏览最新内容;
有了filesite,你可以保留现有的本地内容创作习惯,并非常容易地把它们制作成一个网站分享给他人。
@ -66,8 +71,8 @@ https://git.filesite.io/filesite/machete/archive/master.zip @@ -66,8 +71,8 @@ https://git.filesite.io/filesite/machete/archive/master.zip
| 名称 | 网址 |
| ---- | ---- |
| 站长手册 | <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> |
| 站长手册 | <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. 小说站
@ -78,6 +83,7 @@ https://git.filesite.io/filesite/machete/archive/master.zip @@ -78,6 +83,7 @@ https://git.filesite.io/filesite/machete/archive/master.zip
| 名称 | 网址 |
| ---- | ---- |
| 看美女 | <a href="https://googleimage.filesite.io" target="_blank">GoogleImage.Filesite.io</a> |
| 在线演示 | <a href="https://demo.jialuoma.cn" target="_blank">带后台版Machete在线演示</a> |
5. 视频站
@ -92,25 +98,30 @@ Machete是砍刀,它能砍、能削、能切、能剁,最适合披荆斩棘 @@ -92,25 +98,30 @@ Machete是砍刀,它能砍、能削、能切、能剁,最适合披荆斩棘
砍刀不像大刀、长剑、长矛为战场而生,但在日常生活中使用也是得心应手。
Filesite.io也一样,它短小精悍,使用它把常见的本地文件制作成网站,就像拿起砍刀一样简单, 所以我们将filesite.io的源码命名为**machete**。
Filesite.io也一样,它短小精悍,使用它把常见的本地文件制作成网站,就像拿起砍刀一样简单, 所以我们将FileSite.io的源码命名为**machete**。
点击下面网址查看源码或者下载源码:
* 查看<a href="https://git.filesite.io/filesite/machete" target="_blank">filesite.io源码Machete</a>
* 查看<a href="https://git.filesite.io/filesite/machete" target="_blank">FileSite.io源码Machete</a>
* 用git下载:
```
git clone https://git.filesite.io/filesite/machete.git
```
* 还可以下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)):
* 下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)):
```
https://git.filesite.io/filesite/machete/archive/master.zip
```
* 从dockerhub下载镜像:
* 从Docker Hub下载镜像:
```
docker pull filesite/machete
```
支持samba文件共享管理内容的版本:
```
docker pull filesite/machete:samba
```
启动容器:
@ -118,12 +129,33 @@ docker pull filesite/machete @@ -118,12 +129,33 @@ docker pull 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
```
更多使用说明见machete源码README.md。
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。
@ -158,12 +190,12 @@ FileSite.io官方提供的皮肤都包含在最新版的源码目录```themes/`` @@ -158,12 +190,12 @@ FileSite.io官方提供的皮肤都包含在最新版的源码目录```themes/``
如果要基于Machete做二次开发,请先仔细阅读下面手册。
filesite.io核心代码参考:
FileSite.io核心代码参考:
* [Filesite.io core lib](./FSC.md)
* [Nginx配置示例](./Nginx.conf.md)
filesite.io二次开发参考:
* [filesite.io使用手册](./Manual.md)
FileSite.io二次开发参考:
* [FileSite.io使用手册](./Manual.md)
* [类DirScanner定义](./Class_DirScanner.md)
@ -184,4 +216,9 @@ filesite.io二次开发参考: @@ -184,4 +216,9 @@ filesite.io二次开发参考:
## 联系我们
加入QQ群:
<a href="https://jq.qq.com/?_wv=1027&k=WoH3Pv7d" target="_blank">网址导航、图片、视频网站交流群</a>
扫码加微信好友:
<img src="./wx_jialuoma.jpeg" alt="扫描微信二维码加好友" width="240" />

Loading…
Cancel
Save