Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 67 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,86 @@
# OpenAList
[中文](./README_cn.md) | English
[中文](./README_cn.md) | English

## Notice
This is a fork of [Alist](https://github.com/alist-org/alist) based on version 3.45.0.
## Introduction

The document site has been deployed: http://alist.iots.vip/
**OpenAList** is a community-driven fork of [Alist](https://github.com/alist-org/alist) (based on v3.45.0), aiming to provide a more secure, customizable, and user-friendly file listing and management solution.

As for obtaining tokens for various cloud drives, it is strongly recommended to use an offline solution (the original API provided by the project's author has been replaced with a black hole to avoid security risks).
- **Document site**: http://alist.iots.vip/

## Features

## Description
OpenAList is an forked version of the original Alist file list program.
- 🗂️ Supports multiple mainstream cloud drives and local storage
- 🔒 Safer token acquisition (removed insecure original APIs)
- 🛠️ UI and driver enhancements
- 🚀 Continuous integration Docker image, ready to use
- 🧩 Easy for secondary development and customization
- 📝 Compatible with most original Alist features

Considering that several forked organizations are still in the onboarding phase and it's hard to distinguish genuine ones from fake.
## Quick Start

For personal use, I have already forked and modified this part of the code.
### Using Docker

If you need it urgently, you can directly use my image tag `alliot/alist:latest`.
> Please note, since the static password salt has been changed, you need to reset the password when using this image
> `docker exec -it alist /bin/sh`
> Then execute `./alist admin set my_new_password`
```bash
docker run -d \
--name=alist \
-p 5244:5244 \
-v /path/to/data:/opt/alist/data \
alliot/alist:latest
```

The image was built from the following repository CIs, feel free to review them yourself:
https://github.com/AlliotTech/openalist
https://github.com/AlliotTech/openalist-web
https://github.com/AlliotTech/openalist-docs
> **Note:**
> The static password salt has changed. Please reset the admin password on first use:
> ```
> docker exec -it alist /bin/sh
> ./alist admin set <your_new_password>
> ```

### Local Deployment

## Features
- Original Alist features
- etc.
1. Clone the repository:
```bash
git clone https://github.com/AlliotTech/openalist.git
cd openalist
```
2. Build and run:
```bash
./build.sh
./alist server
```

## Configuration

- Config file path: `data/config.json`
- Strongly recommend using offline/local tools to obtain cloud drive tokens for security
- For OneDrive: use [alist-onedrive-api](https://github.com/vtzp/alist-onedrive-api) or mount WebDAV via rclone

## FAQ

- **Q: How to securely obtain cloud drive tokens?**
A: Use local or offline tools, never use untrusted online services.

- **Q: The image/program fails to start?**
A: Check for port conflicts, data directory permissions, etc.

- **Q: How to report bugs or suggestions?**
A: Please submit via [GitHub Issues](https://github.com/AlliotTech/openalist/issues).

## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.

We welcome contributions! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) and submit a Pull Request.

## Images & Related Repositories

- [openalist](https://github.com/AlliotTech/openalist)
- [openalist-web](https://github.com/AlliotTech/openalist-web)
- [openalist-docs](https://github.com/AlliotTech/openalist-docs)

## Acknowledgments

- Original [Alist Project](https://github.com/alist-org/alist)
- All open-source contributors

## More

## More
https://github.com/AlistGo/alist/issues/8649
https://github.com/AlistGo/alist/issues/8651
...
- [AlistGo/alist/issues/8649](https://github.com/AlistGo/alist/issues/8649)
- [AlistGo/alist/issues/8651](https://github.com/AlistGo/alist/issues/8651)
100 changes: 65 additions & 35 deletions README_cn.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,86 @@
# OpenAList
[English](./README.md) | 中文
## 注意
> 这是基于版本 3.45.0 的 [Alist](https://github.com/alist-org/alist) 分支。
[English](./README.md) | 中文

文档站已经部署: http://alist.iots.vip/
## 项目简介

至于各网盘的 Token 获取,强烈建议使用离线方案(项目中的原作者提供的 API 我已经替换为黑洞, 避免安全风险。)
**OpenAList** 是基于 [Alist](https://github.com/alist-org/alist) v3.45.0 的社区驱动分支,致力于提供更安全、可定制、易用的文件列表与管理解决方案。

- **文档站**: http://alist.iots.vip/

### onedrive 处置方法
原先依赖的是 `api.nn.ci` 这个域名提供的 API 服务。 由于这个服务并不开源,因此为了安全考虑尽量替换掉它。
做法:
去 Azure 应用里面将这个应用程序删除。 (寻找回调地址为 https://api.nn.ci/alist/ali_open/token 的即可)
## 主要特性

那么现在还想用 onedrive 怎么办?
- 🗂️ 支持多种主流网盘和本地存储
- 🔒 更安全的 Token 获取方式(已移除原有不安全 API)
- 🛠️ UI 优化与驱动增强
- 🚀 镜像持续集成,开箱即用
- 🧩 易于二次开发和自定义
- 📝 兼容原版 Alist 的大部分功能

方法一: rclone 挂载 webdav 给 alist
方法二: 用如下类似: https://github.com/vtzp/alist-onedrive-api 项目 本地生成 refresh_token (用法很简单,下载 index.html 在本地双击打开,然后按照提示创建应用程序,并填入 client_id secret 等进行手动操作即可)
## 快速开始

### 使用 Docker

## 描述
OpenAList 是原始 Alist 文件列表程序的一个分支版本。
```bash
docker run -d \
--name=alist \
-p 5244:5244 \
-v /path/to/data:/opt/alist/data \
alliot/alist:latest
```

鉴于好几个 fork 的组织还在 onboard 阶段,并且难辨真假。
> **注意:**
> 由于静态密码 salt 已更改,首次使用请重置管理员密码:
> ```
> docker exec -it alist /bin/sh
> ./alist admin set <你的新密码>
> ```

为了自用,我已经 fork 并且修改了这部分的代码。急用可以直接用我的镜像 `alliot/alist:latest`
### 本地部署

> 需要注意, 由于修改了静态密码 salt, 所以用这个镜像需要重置密码
> `docker exec -it alist /bin/sh`
> 然后执行 `./alist admin set my_new_password` )
1. 克隆仓库:
```bash
git clone https://github.com/AlliotTech/openalist.git
cd openalist
```
2. 构建并运行:
```bash
./build.sh
./alist server
```

构建镜像来自如下仓库 CI, 不放心的可以自行审查:
https://github.com/AlliotTech/openalist
https://github.com/AlliotTech/openalist-web
https://github.com/AlliotTech/openalist-docs
## 配置说明

强烈建议仅将此作为临时方案,因为我只是给自己和几个朋友自用的。
- 配置文件路径:`data/config.json`
- 强烈建议使用离线/本地工具获取各网盘 Token,避免安全风险
- OneDrive 推荐方案:使用 [alist-onedrive-api](https://github.com/vtzp/alist-onedrive-api) 或 rclone 挂载 WebDAV

## 常见问题

- **Q: 如何安全获取各网盘 Token?**
A: 建议使用本地或离线工具获取,切勿使用不明在线服务。

## 功能
- 原版 Alist 功能
- UI优化, 驱动优化
- 部分网盘功能增强(自行探索...)
- **Q: 镜像/程序无法启动?**
A: 请检查端口占用、数据目录权限等常见问题。

## 贡献
欢迎贡献!请随时提交 Pull Request。
- **Q: 如何反馈 Bug 或建议?**
A: 欢迎通过 [GitHub Issues](https://github.com/AlliotTech/openalist/issues) 提交。

## 贡献指南

欢迎贡献代码、文档或建议。请先阅读 [CONTRIBUTING.md](./CONTRIBUTING.md) 并提交 Pull Request。

## 镜像与相关仓库

- [openalist](https://github.com/AlliotTech/openalist)
- [openalist-web](https://github.com/AlliotTech/openalist-web)
- [openalist-docs](https://github.com/AlliotTech/openalist-docs)

## 致谢

## 致谢
- 原始 [Alist 项目](https://github.com/alist-org/alist)
- 所有开源贡献者

## 更多

## 更多
https://github.com/AlistGo/alist/issues/8649
https://github.com/AlistGo/alist/issues/8651
...
- [AlistGo/alist/issues/8649](https://github.com/AlistGo/alist/issues/8649)
- [AlistGo/alist/issues/8651](https://github.com/AlistGo/alist/issues/8651)