How to

Add a meta record.

添加元信息

An example of using nginx to reverse proxy to https://example.com/openlist:

• Normal installation
• Set site_url to https://example.com/openlist or just /openlist then restart openlist
• Add a reverse proxy record in nginx

location /openlist/ {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
	  proxy_set_header If-Range $http_if_range;
    proxy_redirect off;
    proxy_pass http://127.0.0.1:5244/openlist/;
    # the max size of file to upload
    client_max_body_size 20000m;
}

使用 nginx 反向代理到 https://example.com/openlist 的示例：

• 正常安装
• 将 site_url 设置为 https://example.com/openlist 或者仅/openlist, 然后重启alist
• 在 nginx 中添加反向代理配置

location /openlist/ {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header Host $http_host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header Range $http_range;
    proxy_set_header If-Range $http_if_range;
    proxy_redirect off;
    proxy_pass http://127.0.0.1:5244/openlist/;
    # the max size of file to upload
    client_max_body_size 20000m;
}

If you are the owner of the site, you can get the admin’s info by run ./openlist admin in the terminal. Otherwise you can ask the owner to reset the password.

如果您是站点的所有者，您可以通过在终端中运行 ./openlist admin 来获取管理员账号信息。

否则，您可以要求站点所有者重置密码。

Versions above 3.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

# Randomly generate a password
./openlist admin random
# Manually set a password, `NEW_PASSWORD` refers to the password you need to set
./openlist admin set NEW_PASSWORD

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

# 随机生成一个密码
./openlist admin random
# 手动设置一个密码,`NEW_PASSWORD`是指你需要设置的密码
./openlist admin set NEW_PASSWORD

Refer to config

参考config

Except for the incompatible version marked in the changelog, you can directly replace the binary file to upgrade.

For docker user, just remove the old container and pull the new image then run it.

除了 changelog 中标注的不兼容版本，通常可以直接替换二进制文件进行更新。

对于 docker 用户，只需删除旧的容器并拉取新的docker image，然后运行它即可。

Add a meta record, and open write field.

添加元信息，并启用"写入"

According to our open source license: Permissions of this strongest copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. When a modified version is used to provide a service over a network, the complete source code of the modified version must be made available.

根据我们的开源许可: 此最强copyleft许可的权限以在同一许可下提供许可作品和修改的完整源代码为条件，其中包括使用许可作品的较大作品。版权和许可声明必须保留 贡献者明确授予专利权。当使用修改后的版本通过网络提供服务时，必须提供修改后版本的完整源代码。

It may be that the risk detection system has been triggered. Please changing the password, then, add it again.

可能是触发了风控。更改密码后，再次添加即可。

For network problems such as these, please troubleshoot and solve them yourself.Don’t create any issues for this.

诸如此类的网络问题，请自行排查解决。不要为此提出任何的issue

Background --> Settings --> Preview --> Iframe preview, written behind the PDF

 /*The comma below is also oh, don’t copy this comment, start copying from the second line*/
,
  "epub": {
    "EPUB.js":"/static/epub.js/viewer.html?url=$e_url"
  }

Version 3.7.x and higher already support ".epub" reading But you need to add it manually (because the database has already been created, it is not good to overwrite it for you, and you will make mistakes) If it is the first installation and startup (version 3.7.x and higher), no need to add it manually If the secondary directory reverse generation is set, please add the corresponding prefix in site_url, and then restart OpenList to take effect

后台 ——>设置——>预览——>Iframe 预览，写在PDF后面

/*下面的这个逗号也是哦，这个注释就不要复制了，从第二行开始复制*/
,
  "epub": {
    "EPUB.js":"/static/epub.js/viewer.html?url=$e_url"
  }

3.7.x 版本及更高的版本已经支持 ".epub" 阅读 但是需要自己手动添加(因为已经创建过数据库了 不好给你覆盖会出错) 如果是第一次安装启动（3.7.x版本及更高的版本）不用手动添加 如果设置了二级目录反代，请在site_url中自行添加相应前缀，然后重启OpenList才会生效

If you find a bug, but the log.log log is not detailed, you can try to add the --debug parameter to start

It is recommended to clear the log file /log/log.log in the OpenList directory before starting with the --debug parameter, so that developers can quickly locate problems later

如果发现Bug，但是log.log的日志不详细，可以尝试在 启动时候添加 --debug 参数启动

建议在使用--debug 参数启动之前将 OpenList目录下的日志文件/log/log.log 清空，这样方便开发者们后续快速定位问题

• Windows：openlist.exe server --debug
• Linux：./openlist server --debug
• Mac: Temporarily unknown, maybe it is started with the --debug parameter
• Docker：docker exec -it openlist ./openlist server --debug

How to stop the relevant logs after startup? Ctrl+c can stop the program (or simply close the program directly)

• Windows：openlist.exe server --debug
• Linux：./openlist server --debug
• Mac：暂时未知，可能也是可以加 --debug 参数启动
• Docker：docker exec -it openlist ./openlist server --debug

启动后拿到相关日志，如何停止? Ctrl+c 可以使程序停止运行（或者简单粗暴直接关闭程序）