openalist

command module
v0.0.0-...-6e53ccd Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 29, 2025 License: AGPL-3.0 Imports: 1 Imported by: 0

README

OpenAList

中文 | English

Introduction

OpenAList is a community-driven fork of Alist (based on v3.45.0), aiming to provide a more secure, customizable, and user-friendly file listing and management solution.

Features

  • 🗂️ 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

Quick Start

Using Docker
docker run -d \
  --name=alist \
  -p 5244:5244 \
  -v /path/to/data:/opt/alist/data \
  alliot/alist:latest

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
  1. Clone the repository:
    git clone https://github.com/AlliotTech/openalist.git
    cd openalist
    
  2. Build and run:
    ./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 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.

Contributing

We welcome contributions! Please read CONTRIBUTING.md and submit a Pull Request.

Acknowledgments

More

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
115
123
139
189
ftp
s3
smb
uss
webdav/odrvcookie
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint
Package odrvcookie can fetch authentication cookies for a sharepoint webdav endpoint
internal
db
fs
net
op
pkg
gowebdav
Package gowebdav is a WebDAV client library with a command line tool included.
Package gowebdav is a WebDAV client library with a command line tool included.
http_range
Package http_range implements http range parsing.
Package http_range implements http range parsing.
mq
singleflight
Package singleflight provides a duplicate function call suppression mechanism.
Package singleflight provides a duplicate function call suppression mechanism.
task
Package task manage task, such as file upload, file copy between storages, offline download, etc.
Package task manage task, such as file upload, file copy between storages, offline download, etc.
ftp
s3
Credits: https://pkg.go.dev/github.com/rclone/rclone@v1.65.2/cmd/serve/s3 Package s3 implements a fake s3 server for alist
Credits: https://pkg.go.dev/github.com/rclone/rclone@v1.65.2/cmd/serve/s3 Package s3 implements a fake s3 server for alist
webdav
Package webdav provides a WebDAV server implementation.
Package webdav provides a WebDAV server implementation.
webdav/internal/xml
Package xml implements a simple XML 1.0 parser that understands XML name spaces.
Package xml implements a simple XML 1.0 parser that understands XML name spaces.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL