linuxserver/heimdall
[!TIP]
前半部分是翻译官方的文档,最后一部分是我的简单试用(个别软件会深度试用),如果对Docker已经有一定的了解了,可以直接跳转到最后面 翻译之外 这部分来查看。
Heimdall → https://heimdall.site/
GitHub → https://github.com/linuxserver/docker-heimdall
Docker Hub → https://hub.docker.com/r/linuxserver/heimdall
Heimdall 可以很方便、简单地组织你所有的常用网站和Web应用链接。简洁是Heimdall的关键,可以把它设置为你浏览器的起始页面,它甚至可以使用Google、Bing 或 DuckDuckGo 的搜索栏。
支持的系统架构
得益于docker的跨平台属性,我们的镜像也支持多架构(如,x86-64、arm64、armhf)。
直接拉取 ghcr.io/linuxserver/heimdall
应该就可以自动获取适合你系统架构的版本,当然你也可以通过 tag 获取特定的版本。
架构 | Tag |
---|---|
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
版本标签
Tag | 描述 |
---|---|
latest | Heimdall 的稳定发行版 |
development | github上 master 分支的最新版本 |
拉取镜像
docker pull ghcr.io/linuxserver/heimdall
使用方法
以下是一些简单的示例。
docker-compose
兼容docker-compose v2
---
version: "2.1"
services:
heimdall:
image: ghcr.io/linuxserver/heimdall
container_name: heimdall
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- </path/to/appdata/config>:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
docker cli
docker run -d \
--name=heimdall \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 80:80 \
-p 443:443 \
-v </path/to/appdata/config>:/config \
--restart unless-stopped \
ghcr.io/linuxserver/heimdall
参数
Docker镜像在使用的时候需要配置一些参数,这些参数使用 :
分隔,分别表示 宿主机:容器内
。例如 -p 8080:80
指的是将容器内的80
端口映射到宿主机上的8080
端口,即通过宿主机网络访问的话,访问8080
端口即是访问容器内的80
端口。
端口(-p
)
port | 说明 |
---|---|
80 |
HTTP Web界面 |
443 |
HTTPS Web界面 |
环境变量(-e
)
env | 说明 |
---|---|
PUID=1000 |
用户的 UID,详见下面的说明 |
PGID=1000 |
用户的 GID,详见下面的说明 |
TZ=Europe/London |
设置时区,在国内的话可以使用 Asia/Shanghai |
卷映射(-v
)
volume | 说明 |
---|---|
/config |
配置文件所在路径 |
从文件加载环境变量
可以使用前缀名为 FILE__
的文件来加载环境变量。
例:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
将把 /run/secrets/mysecretpassword
文件中的内容作为 PASSWORD
变量的值。
运行程序的umask(文件掩码)
我们所有的镜像都可以使用 -e UMASK=022 来设置覆盖容器内服务的umask。关于Linux umask可以通过这里了解,或自行百度学习。
UID和GID
当使用 -v
映射卷的时候,宿主机和容器内会出现关于权限的问题,我们的镜像可以通过指定 PUID
和 GUID
来避免此类问题。
可以使用你目前正在使用的用户的UID和GID进行设置,这样就不会存在权限问题。
可以通过如下的方式查看当前用户的UID和GID:
$ id $user
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
[!NOTE]
如果没特殊需求,可以将后续所有容器的id都设置为当前非root用户的id,这样会省去解决很多关于文件权限的问题(可以查看 什么是PUID和PGID 这篇文章了解更多)。当然,如果有特殊需要可以给不同的容器设置不同的id,即分配给不同的用户。使用
useradd
命令即可添加用户。通常来说,除root账户外,第一个建立的用户的UID和GID都是1000,然后递增生成。
安装说明
访问 http://ip
即可使用。
添加密码保护
该映像现在支持通过htpasswd进行密码保护。运行以下命令以生成htpasswd文件:
docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>
输入你的用户名后再输入密码后,新的安装将自动启动并开启密码保护。更新镜像后,可以删除 /config/nginx/site-confs/default
下的配置文件并重启容器,即可创建一个新的具有密码保护功能的网站。
支持
- 进入容器:
docker exec -it heimdall /bin/bash
- 查看容器日志:
docker logs -f heimdall
- 查看容器版本号:
docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' heimdall
- 查看镜像版本号:
docker inspect -f '{% raw %}{{% endraw %}{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/heimdall
翻译之外
暂未试用