ready for public

Author: zhaochunqi

.env.example

@@ -1,5 +1,5 @@
 LITESTREAM_ACCESS_KEY_ID=
 LITESTREAM_SECRET_ACCESS_KEY=
 LITESTREAM_S3_BUCKET=
-LITESTREAM_S3_ENDPOINT=https://s3.us-west-002.backblazeb2.com
+LITESTREAM_S3_ENDPOINT=https://custom-endpoint
 LITESTREAM_S3_PATH=linkding

.github/workflows/publish.yml

@@ -54,3 +54,7 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
           platforms: linux/amd64,linux/arm64
+          build-args: |
+            VERSION=${{ github.ref_name }}
+            BUILD_DATE=${{ fromJSON(steps.meta.outputs.json).labels['org.opencontainers.image.created'] }}
+            VCS_REF=${{ github.sha }}

Dockerfile

@@ -1,13 +1,46 @@
+# Build arguments for metadata
+ARG VERSION="latest"
+ARG BUILD_DATE
+ARG VCS_REF
+
+# Stage 1: Get Litestream binary
 FROM litestream/litestream:0.3 AS builder
 
+# Stage 2: Main image based on Linkding
 FROM sissbruecker/linkding:latest
 
-# Install Litestream
+# OCI standard labels
+# See: https://github.com/opencontainers/image-spec/blob/main/annotations.md
+LABEL org.opencontainers.image.title="Linkding with Litestream" \
+      org.opencontainers.image.description="Self-hosted bookmark manager (Linkding) with automated SQLite backup to S3 using Litestream" \
+      org.opencontainers.image.url="https://github.com/zhaochunqi/linkding-deployment" \
+      org.opencontainers.image.source="https://github.com/zhaochunqi/linkding-deployment" \
+      org.opencontainers.image.version="${VERSION}" \
+      org.opencontainers.image.created="${BUILD_DATE}" \
+      org.opencontainers.image.revision="${VCS_REF}" \
+      org.opencontainers.image.licenses="MIT" \
+      org.opencontainers.image.vendor="zhaochunqi" \
+      org.opencontainers.image.authors="zhaochunqi" \
+      org.opencontainers.image.documentation="https://github.com/zhaochunqi/linkding-deployment/blob/main/README.md"
+
+# Legacy labels for compatibility
+LABEL maintainer="zhaochunqi" \
+      org.label-schema.schema-version="1.0" \
+      org.label-schema.name="Linkding with Litestream" \
+      org.label-schema.description="Self-hosted bookmark manager with S3 backup" \
+      org.label-schema.url="https://github.com/zhaochunqi/linkding-deployment" \
+      org.label-schema.vcs-url="https://github.com/zhaochunqi/linkding-deployment" \
+      org.label-schema.version="${VERSION}" \
+      org.label-schema.build-date="${BUILD_DATE}" \
+      org.label-schema.vcs-ref="${VCS_REF}"
+
+# Install Litestream binary from builder stage
 COPY --from=builder /usr/local/bin/litestream /usr/local/bin/litestream
 
-# Copy configuration and entrypoint
+# Copy Litestream configuration and custom entrypoint
 COPY litestream.yml /etc/litestream.yml
 COPY entrypoint.sh /entrypoint.sh
 RUN chmod +x /entrypoint.sh
 
+# Use custom entrypoint that handles database restore and replication
 ENTRYPOINT ["/entrypoint.sh"]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 zhaochunqi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -8,7 +8,35 @@
 - 💾 自动备份 SQLite 数据库到 S3 兼容存储
 - 🔄 容器重启时自动从备份恢复数据库
 
-## 快速开始
+## 使用预构建镜像
+
+### 可用标签
+
+镜像发布在 GitHub Container Registry,支持以下标签:
+
+- `latest`: 最新版本 (推荐用于生产环境)
+- `sha-<commit>`: 特定 commit 版本 (用于版本锁定)
+- `YYYYMMDD`: 每日构建版本 (用于追踪特定日期的构建)
+
+### 快速运行
+
+使用预构建镜像,无需本地构建:
+
+```bash
+# 1. 配置环境变量
+cp .env.example .env
+# 编辑 .env 填入你的 S3 凭证
+
+# 2. 直接运行
+docker run -d \
+  --name linkding \
+  -p 9090:9090 \
+  --env-file .env \
+  -v linkding-data:/etc/linkding/data \
+  ghcr.io/zhaochunqi/linkding:latest
+```
+
+## 从源码构建
 
 ### 1. 配置环境变量
 
@@ -24,7 +52,7 @@ cp .env.example .env
 LITESTREAM_ACCESS_KEY_ID=your_access_key_id
 LITESTREAM_SECRET_ACCESS_KEY=your_secret_access_key
 LITESTREAM_S3_BUCKET=your_bucket_name
-LITESTREAM_S3_ENDPOINT=https://s3.us-west-002.backblazeb2.com
+LITESTREAM_S3_ENDPOINT=https://custom-endpoint
 LITESTREAM_S3_PATH=linkding
 ```
 
@@ -61,3 +89,12 @@ docker run -d \
 - 保留时间: 7 天
 
 可根据需要修改 `litestream.yml` 中的配置。
+
+## 许可证
+
+本项目采用 [MIT License](LICENSE) 开源。
+
+## 致谢
+
+- [Linkding](https://github.com/sissbruecker/linkding) - 优秀的自托管书签管理器
+- [Litestream](https://litestream.io/) - SQLite 数据库流式复制工具