Manual installation

Get Homelist

获取 Homelist

You can download the corresponding binary executable file for the deployment system from Download page or GitHub Release.

您可以在下载页面或 GitHub Release 下载待部署系统对应的二进制可执行文件。

Install using package manager

使用包管理器安装

Linux

Debian/Ubuntu can be installed from Homelist’s APT repository and PPA repository, and the service (daemon) will be automatically configured.

Debian / Ubuntu 可以从 Homelist 的 APT 仓库和 PPA 仓库安装，且会自动配置好服务（守护进程）。

APT Repository

APT 仓库

Recommended - Automatic GPG Setup

bash

# One-line install with automatic GPG key setup
curl -fsSL https://github.com/HomelistTeam/Homelist-APT/releases/latest/download/install-apt.sh | bash

# Then install Homelist
sudo apt install Homelist -y

Manual APT Setup with GPG Verification (Modern systems - Ubuntu 22.04+/Debian 12+)

bash

# Download and install GPG keyring
curl -fsSL https://github.com/HomelistTeam/Homelist-APT/releases/latest/download/Homelist-archive-keyring.gpg | \
  sudo tee /usr/share/keyrings/Homelist-archive-keyring.gpg > /dev/null

# Add repository with GPG verification
echo "Types: deb
URIs: https://github.com/HomelistTeam/Homelist-APT/releases/latest/download/
Suites: ./
Signed-By: /usr/share/keyrings/Homelist-archive-keyring.gpg" | \
  sudo tee /etc/apt/sources.list.d/Homelist.sources

# Update and install
sudo apt update && sudo apt install Homelist -y

Manual APT Setup without GPG Verification (Not Recommended)

bash

# Modern systems (Ubuntu 22.04+/Debian 12+)
echo "Types: deb
URIs: https://github.com/HomelistTeam/Homelist-APT/releases/latest/download/
Suites: ./
Trusted: yes" | sudo tee /etc/apt/sources.list.d/Homelist.sources

# Legacy systems (Ubuntu <22.04/Debian <12)
echo "deb [trusted=yes] https://github.com/HomelistTeam/Homelist-APT/releases/latest/download/ ./" | \
  sudo tee /etc/apt/sources.list.d/Homelist.list

# Update and install
sudo apt update && sudo apt install Homelist -y

PPA Repository

PPA 仓库

Alternative - Launchpad

bash

# Add PPA repository
sudo add-apt-repository ppa:Homelist/server
sudo apt update

# Install Homelist
sudo apt install Homelist -y

备用方法 - Launchpad

bash

# 添加 PPA 仓库
sudo add-apt-repository ppa:Homelist/server
sudo apt update

# 安装 Homelist
sudo apt install Homelist -y

Flatpak

Homelist can be installed as a Flatpak package on most Linux distributions. Flatpak provides a sandboxed environment and automatic updates.

Homelist 可以在大多数 Linux 发行版上作为 Flatpak 软件包安装。Flatpak 提供沙盒环境和自动更新。

One-line Installation (Recommended)

bash

curl -fsSL https://github.com/HomelistTeam/Homelist-FLATPAK/releases/latest/download/install-flatpak.sh | bash

Manual Installation

bash

# Install Flatpak (if not already installed)
# On Ubuntu/Debian
sudo apt install flatpak

# On Fedora
sudo dnf install flatpak

# On Arch Linux
sudo pacman -S flatpak

# Add Flathub repository (required for dependencies)
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

# Download and install Homelist Flatpak package
wget https://github.com/HomelistTeam/Homelist-FLATPAK/releases/latest/download/org.oplist.Homelist-linux-x86_64.flatpak
flatpak install --user --bundle org.oplist.Homelist-linux-x86_64.flatpak -y

# Start Homelist
flatpak run org.oplist.Homelist server

一行命令安装（推荐）

bash

curl -fsSL https://github.com/HomelistTeam/Homelist-FLATPAK/releases/latest/download/install-flatpak.sh | bash

手动安装

bash

# 安装 Flatpak（如果尚未安装）
# 在 Ubuntu/Debian
sudo apt install flatpak

# 在 Fedora
sudo dnf install flatpak

# 在 Arch Linux
sudo pacman -S flatpak

# 添加 Flathub 仓库（依赖项所需）
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo

# 下载并安装 Homelist Flatpak 软件包
wget https://github.com/HomelistTeam/Homelist-FLATPAK/releases/latest/download/org.oplist.Homelist-linux-x86_64.flatpak
flatpak install --user --bundle org.oplist.Homelist-linux-x86_64.flatpak -y

# 启动 Homelist
flatpak run org.oplist.Homelist server

Windows

Homelist can be installed from package managers Scoop main and WinGet on Windows.

Windows 可以从 Scoop main 和 WinGet 安装。

Scoop

powershell

scoop install Homelist
Homelist server

WinGet

powershell

winget install HomelistTeam.Homelist
Homelist server

macOS

Homelist is available via Homebrew on macOS.

macOS 可以从 Homebrew 安装。

Homebrew

bash

$ brew install Homelist

Android

TIP

Homelist follows the AGPL 3.0 open-source license, assumes no responsibility for any downstream derivative projects, and reserves the right to pursue their compliance with the same license.

TIP

Homelist 遵循 AGPL 3.0 开源协议，对任何下游衍生项目概不负责，且保留追究其同样遵守该协议的权利。

There are four ways to choose based on your needs

Using https://github.com/HomelistTeam/Homelist-Mobile
Using https://github.com/LeoHaoVIP/AListLiteAndroid
Using https://github.com/jing332/AListFlutter (no longer maintained)
Use termux to run
- Reference: https://anwen-anyi.github.io/index/14-android_install.html
- Note: Remember to authorize the APP, set the background running and battery saving policy to unlimited, otherwise it may be killed in the background, causing it to be suddenly interrupted and unusable during background use.

有四种办法根据自己的需求选择

使用 https://github.com/HomelistTeam/Homelist-Mobile
使用 https://github.com/LeoHaoVIP/AListLiteAndroid
使用 https://github.com/jing332/AListFlutter (已停止维护)
使用 termux 运行
- 参考：https://anwen-anyi.github.io/index/14-android_install.html
- 注意事项：记得给APP授权，后台运行、电池省电策略设置为无限制，否则可能会被杀后台导致挂在后台使用期间突然中断无法使用

Termux

bash

pkg update
pkg install Homelist
Homelist server

Running

手动运行

bash

Usage:
  Homelist [command]

Available Commands:
  admin       Show admin user's info and some operations about admin user's password
  cancel2fa   Delete 2FA of admin user
  completion  Generate the autocompletion script for the specified shell
  crypt       Encrypt or decrypt local file or dir
  help        Help about any command
  kill        Force kill Homelist server process by daemon/pid file
  lang        Generate language json file
  restart     Restart Homelist server by daemon/pid file
  server      Start the server at the specified address
  start       Silent start Homelist server with `--force-bin-dir`
  stop        Same as the kill command
  storage     Manage storage
  version     Show current version of Homelist

Flags:
      --data string     data folder (default "data")
      --config string   config file (default "data/config.json")
      --debug           start with debug mode
      --dev             start with dev mode
      --force-bin-dir   Force to use the directory where the binary file is located as data directory
  -h, --help            help for Homelist
      --log-std         Force to log to std
      --no-prefix       disable env prefix

Use "Homelist [command] --help" for more information about a command.

bash

使用方法：
  Homelist [命令]

可用命令：
  admin      显示管理员用户的信息及管理员用户密码相关操作
  cancel2fa  删除管理员用户的 2FA
  completion 生成指定 shell 的自动补全脚本
  crypt      加密或解密本地文件或目录
  help       显示命令帮助
  kill       强制通过守护进程/进程 ID 文件终止 Homelist 服务器进程
  lang       生成语言 JSON 文件
  restart    通过守护进程/进程 ID 文件重启 Homelist 服务器
  server     启动指定地址的服务器
  start      静默启动 Homelist 服务器，使用 `--force-bin-dir`
  stop       与 kill 命令相同
  storage    管理存储
  version    显示当前 Homelist 版本

标志参数：
  --data string   数据文件夹（默认值 "data"）
  --config string 配置文件（默认值 "data/config.json"）
  --debug         启动时使用调试模式
  --dev           启动时使用开发模式
  --force-bin-dir 强制使用二进制文件所在目录作为数据目录
  -h, --help      显示 Homelist 命令帮助
  --log-std       强制日志输出到标准输出
  --no-prefix     禁用环境前缀

使用 "Homelist [命令] --help" 获取更多命令信息。

TIP

If there is a prompt as follows：It is because your GLIBC version is too low, it is recommended to download the musl version.

txt

lib64/libc.so.6: version `GLIBC_2.28' not found (required by ./Homelist)
accept: function not implemented

When you see the output of start server @ 0.0.0.0:5244 and no error is reported afterwards, it means that the operation is successful. The initial password will be output when running for the first time. The program listens to port 5244 by default. Now open http://ip:5244 You can see the login page, please see WebDav for webdav.

For Flatpak Users

If you installed Homelist via Flatpak, use the following commands instead:

bash

# Start server
flatpak run org.oplist.Homelist server

# Show admin info
flatpak run org.oplist.Homelist admin

# Generate random admin password
flatpak run org.oplist.Homelist admin random

# Set admin password
flatpak run org.oplist.Homelist admin set NEW_PASSWORD

# Show version
flatpak run org.oplist.Homelist version

TIP

手动安装如果有如下提示：是因为你的 GLIBC 版本太低，建议下载 musl 版本。

txt

lib64/libc.so.6: version `GLIBC_2.28' not found (required by ./Homelist)
accept: function not implemented

当你看到 start server@0.0.0.0:5244 的输出，之后没有报错，说明操作成功。第一次运行时会输出初始密码。程序默认监听 5244 端口。现在打开 http://ip:5244 可以看到登录页面，WebDAV 请参阅 WebDav。

Flatpak 用户

如果您通过 Flatpak 安装了 Homelist，请使用以下命令：

bash

# 启动服务器
flatpak run org.oplist.Homelist server

# 显示管理员信息
flatpak run org.oplist.Homelist admin

# 生成随机管理员密码
flatpak run org.oplist.Homelist admin random

# 设置管理员密码
flatpak run org.oplist.Homelist admin set NEW_PASSWORD

# 显示版本
flatpak run org.oplist.Homelist version

WARNING

Versions above v3.25.0 change the password to an encrypted hash value, and the password cannot be calculated directly. If the password is forgotten, it can only be re-randomly generated or manually set.

WARNING

v3.25.0以上版本将密码改成加密方式存储的hash值，无法直接反算出密码，如果忘记了密码只能通过重新 随机生成 或者 手动设置。

The xxxx refers to the names corresponding to different systems/architectures, generally Linux-x86/64 is Homelist-linux-amd64.

xxxx 指的是不同系统/架构对应的名称，一般 Linux-x86/64 为 Homelist-linux-amd64。

Linux

bash

tar -zxvf Homelist-xxxx.tar.gz
chmod +x Homelist
./Homelist server
./Homelist admin
./Homelist admin random
./Homelist admin set NEW_PASSWORD

macOS

bash

tar -zxvf Homelist-xxxx.tar.gz
chmod +x Homelist
./Homelist server
./Homelist admin
./Homelist admin random
./Homelist admin set NEW_PASSWORD

Windows

powershell

Expand-Archive .\Homelist-xxxx.zip
.\Homelist.exe server
.\Homelist.exe admin
.\Homelist.exe admin random
.\Homelist.exe admin set NEW_PASSWORD

Daemon

守护进程

Linux

vim /usr/lib/systemd/system/Homelist.service add the following content, where path_Homelist is the path where Homelist is located:

使用任意方式编辑 /usr/lib/systemd/system/Homelist.service 并添加如下内容，其中 path_Homelist 为 Homelist 所在的路径：

ini

[Unit]
Description=Homelist
After=network.target
[Service]
Type=simple
WorkingDirectory=path_Homelist
ExecStart=path_Homelist/Homelist server
Restart=on-failure
[Install]
WantedBy=multi-user.target

Then systemctl daemon-reload, now you can use these commands to manage the program:

Start: systemctl start Homelist
Shut down: systemctl stop Homelist
Self-start: systemctl enable Homelist
Cancel Self-start: systemctl disable Homelist
Status: systemctl status Homelist
Restart: systemctl restart Homelist

Can’t configure daemon? Video Tutorial

然后，执行 systemctl daemon-reload 重载配置，现在你可以使用这些命令来管理程序：

启动: systemctl start Homelist
关闭: systemctl stop Homelist
配置开机自启: systemctl enable Homelist
取消开机自启: systemctl disable Homelist
状态: systemctl status Homelist
重启: systemctl restart Homelist

守护进程不会配置? 视频教程

macOS

Edit ~/Library/LaunchAgents/org.Homelist.plist in any way and add the following content, modify path_Homelist to be the path where Homelist is located, and path/to/working/dir to be the working path of Homelist:

使用任意方式编辑 ~/Library/LaunchAgents/org.Homelist.plist 并添加如下内容，修改 path_Homelist 为 Homelist 所在的路径，path/to/working/dir 为 Homelist的工作路径:

xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
     <dict>
         <key>Label</key>
         <string>org.Homelist</string>
         <key>KeepAlive</key>
         <true/>
         <key>ProcessType</key>
         <string>Background</string>
         <key>RunAtLoad</key>
         <true/>
         <key>WorkingDirectory</key>
         <string>path/to/working/dir</string>
         <key>ProgramArguments</key>
         <array>
             <string>path_Homelist/Homelist</string>
             <string>server</string>
         </array>
     </dict>
</plist>

Then, execute launchctl load ~/Library/LaunchAgents/org.Homelist.plist to load the configuration, now you can use these commands to manage the program:

Start: launchctl start ~/Library/LaunchAgents/org.Homelist.plist
Close: launchctl stop ~/Library/LaunchAgents/org.Homelist.plist
Unload configuration: launchctl unload ~/Library/LaunchAgents/org.Homelist.plist

然后，执行 launchctl load ~/Library/LaunchAgents/org.Homelist.plist 加载配置，现在你可以使用这些命令来管理程序：

开启: launchctl start ~/Library/LaunchAgents/org.Homelist.plist
关闭: launchctl stop ~/Library/LaunchAgents/org.Homelist.plist
卸载配置: launchctl unload ~/Library/LaunchAgents/org.Homelist.plist

Windows

Method One

方法1

Download the newest nssm from https://nssm.cc/download.
Unzip the archive and go to the diretory of nssm.exe.
Hold Shift and right click on the blank space, then release and press S or select "powershell here", you should now see a blue window named "Windows PowerShell".
Type .\nssm.exe install Homelist.
Select the path of Homelist.exe for "Path", e.g. D:\Homelist\Homelist.exe; type server for "Argument".
You can custom "Display Name", "Description" and "Startup Type" in "Details" tab.
Go to "I/O" tab and select a file for both "Output (stdout)" and "Output (stderr)", e.g. D:\Homelist\stdout.log. The file itself (stdout.log) may not exist, but the folder (D:\Homelist) must exist.
Click on "Install Service". You can now start the service from services.msc or task manager.

在 https://nssm.cc/download 下载最新版本的 nssm；
在解压后的文件夹内按住 Shift 并右击空白处，选择“在此处打开 Powershell 窗口”；
在弹出的窗口中输入 .\nssm.exe install Homelist；
Path 选择 Homelist.exe 的路径，如 D:\Homelist\Homelist.exe，Arguments 填 server；
Details 选项卡中可以自定义标题和描述，可以选择服务的自启动模式（自动|延迟启动|手动|禁用）；
在 I/O 选项卡为 Output (stdout) 和 Output (stderr) 各自指定一个日志文件的路径，如 D:\Homelist\stdout.log，文件本身（stdout.log）可以不存在，但是指定的目录（D:\Homelist）必须存在；
点击“Install Service”即可。此后可以直接在服务中启动 Homelist。

Method Two

方法2

用 .VBS 脚本启动和停止，分别创建两个脚本分别是 启动.vbs 和 停止.vbs。直接在和 Homelist 启动程序同级文件夹里面双击启动即可，不用担心没有反应直接去浏览器访问即可。

Use .VBS script to start and stop, create two scripts respectively start.vbs and stop.vbs. Just double-click to start it in the folder at the same level as the Homelist startup program, don’t worry about no response, just go to the browser to access it.

Two startup scripts

start.vbs

bash

Dim ws
Set ws = Wscript.CreateObject("Wscript.Shell")
ws.run "Homelist.exe server",vbhide
Wscript.quit

stop.vbs

bash

Dim ws
Set ws = Wscript.CreateObject("Wscript.Shell")
ws.run "taskkill /f /im Homelist.exe",0
Wscript.quit

If the script will not be created, you can download it yourself: Script Download
If the script will not be used, you can watch the video: reference video How to realize Windows startup automatically, you can refer to the script mentioned above to use the video (second).

两个启动脚本

启动.vbs

bash

Dim ws
Set ws = Wscript.CreateObject("Wscript.Shell")
ws.run "Homelist.exe server",vbhide
Wscript.quit

停止.vbs

bash

Dim ws
Set ws = Wscript.CreateObject("Wscript.Shell")
ws.run "taskkill /f /im Homelist.exe",0
Wscript.quit

脚本不会创建的可以自行下载：脚本下载
脚本不会使用的可以看看视频：参考视频 如何实现Windows开机自启，可以参考上面提到的脚本使用视频(第二个)

INFO

For all platform, you can use follow command to silent start, stop and restart. (v3.4.0 and later)

bash

Homelist start
Homelist stop
Homelist restart

INFO

对于所有平台，您可以使用以下命令来静默启动、停止和重新启动。（v3.4.0 及更高版本）

bash

Homelist start
Homelist stop
Homelist restart

Manual installation

Get Homelist

获取 Homelist

Install using package manager

使用包管理器安装

Linux

APT Repository

APT 仓库

PPA Repository

PPA 仓库

Flatpak

Flatpak

Windows

Scoop

WinGet

macOS

Homebrew

Android

Termux

Running

手动运行

Linux

macOS

Windows

Daemon

守护进程

Linux

macOS

Windows

Method One

方法1

Method Two

方法2

How to update

如何更新

Contributors

Manual installation

Get Homelist ​

获取 Homelist ​

Install using package manager ​

使用包管理器安装 ​

Linux ​

APT Repository ​

APT 仓库 ​

PPA Repository ​

PPA 仓库 ​

Flatpak ​

Flatpak ​

Windows ​

Scoop ​

WinGet ​

macOS ​

Homebrew ​

Android ​

Termux ​

Running ​

手动运行 ​

Linux ​

macOS ​

Windows ​

Daemon ​

守护进程 ​

Linux ​

macOS ​

Windows ​

Method One ​

方法1 ​

Method Two ​

方法2 ​

How to update ​

如何更新 ​

Contributors

Get Homelist

获取 Homelist

Install using package manager

使用包管理器安装

Linux

APT Repository

APT 仓库

PPA Repository

PPA 仓库

Flatpak

Flatpak

Windows

Scoop

WinGet

macOS

Homebrew

Android

Termux

Running

手动运行

Linux

macOS

Windows

Daemon

守护进程

Linux

macOS

Windows

Method One

方法1

Method Two

方法2

How to update

如何更新