alist/README.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

2021-12-02 14:38:18 +00:00
<div align="center">
<h3><a href="https://alist.nn.ci">Alist</a></h3>
<p><em>A file list program that supports multiple storage, powered by gin and React.</em></p>
2021-11-03 12:58:19 +00:00
<a href="https://github.com/Xhofe/alist/releases"><img src="https://img.shields.io/github/release/Xhofe/alist?style=flat-square" alt="Release version"></a>
<a href="https://github.com/Xhofe/alist/actions?query=workflow%3ABuild"><img src="https://img.shields.io/github/workflow/status/Xhofe/alist/build?style=flat-square" alt="Build status"></a>
<a href="https://github.com/Xhofe/alist/releases"><img src="https://img.shields.io/github/downloads/Xhofe/alist/total?style=flat-square" alt="Downloads"></a>
2021-12-02 15:01:54 +00:00
<a href="https://github.com/Xhofe/alist/blob/v2/LICENSE"><img src="https://img.shields.io/github/license/Xhofe/alist?style=flat-square" alt="License"></a>
2021-11-03 12:58:19 +00:00
<a href="https://pay.xhofe.top">
<img src="https://img.shields.io/badge/%24-donate-ff69b4.svg?style=flat-square" alt="donate">
</a>
2021-12-02 14:38:18 +00:00
</div>
2021-11-03 12:58:19 +00:00
---
2021-12-02 14:38:18 +00:00
English | [中文](./README_cn.md)
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
## Features
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
- [x] multiple storage
- [x] Local storage
- [x] [aliyundrive](https://www.aliyundrive.com/)
2021-12-02 15:01:54 +00:00
- [x] OneDrive / Sharepoint ([global](https://www.office.com/), [cn](https://portal.partner.microsoftonline.cn),de,us
- [x] [189cloud](https://cloud.189.cn)
2021-12-02 14:38:18 +00:00
- [x] [GoogleDrive](https://drive.google.com/)
- [x] [123pan](https://www.123pan.com/)
- [x] [lanzou](https://pc.woozooo.com/)
- [x] File preview (PDF, markdown, code, plain text, ...)
- [x] Image preview in gallery mode
- [x] Video and audio preview (mp4, mp3, ...)
- [x] Office documents preview (docx, pptx, xlsx, ...)
- [x] `README.md` preview rendering
- [x] File permalink copy and direct file download
- [x] Dark mode
- [x] I18n
- [x] Protected routes (password protection and authentication)
- [x] WebDav (readonly)
- [x] [Docker Deploy](https://hub.docker.com/r/xhofe/alist)
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
## Discussion
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
Please go to our [discussion forum](https://github.com/Xhofe/alist/discussions) for general questions, **issues are for bug reports only.**
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
## Demo
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
Available at: <https://alist.nn.ci>.
2021-11-03 12:58:19 +00:00
2021-12-03 03:24:43 +00:00
![demo](https://inews.gtimg.com/newsapp_ls/0/14256614096/0)
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
## Document
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
<https://alist-doc.nn.ci/en/>
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
## License
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
The `AList` is open-source software licensed under the MIT license.
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
---
2021-11-03 12:58:19 +00:00
2021-12-02 14:38:18 +00:00
> [@Blog](https://www.nn.ci/) · [@GitHub](https://github.com/Xhofe)