跳转到主要内容

家庭使用简单日记本

项目描述

Home Journal

为家庭创建的自托管迷你日记网站,用于记录

  • 回忆
  • 故事
  • 照片
  • 想法
  • 笑话
  • 视频
  • 以及您想记住的其他任何东西

我有一个旧的wordpress博客,我将其转换为markdown文件,并需要一种查看帖子的方式。我在寻找一个自托管的、简单的解决方案。我的一些设计要求是

  • 移动友好,并易于从移动设备发布
  • 需要看起来和感觉像移动应用
  • 需要全部是静态文件,或者尽可能接近
  • 需要基于markdown
  • 需要合理的目录结构
  • 由于这是自托管的,不需要认证或社交认证
  • 不需要数据库
  • 不需要JavaScript框架
  • 最小依赖
  • 不需要通过UI编辑帖子
  • 不需要通过UI删除帖子
  • 能够重新生成所有HTML文件
  • 能够使用文本编辑器添加新帖子

什么正在工作

  • 全文搜索
  • GitHub风格的markdown格式化
  • 索引页面
  • 浅色/深色模式
  • 新建帖子页面
  • 帖子页面
  • 渐进式Web应用(PWA)支持(需要https)
  • PWA作为分享目标
  • 重建静态HTML文件(http://your.server/all
  • 响应式设计
  • 站点初始化
  • 将谷歌动态照片分割成静态照片和视频
  • 除新条目提交外的静态文件
  • 标签页
  • 视频上传

未来增强

  • ¯\_(ツ)\_/¯

安装

pip install home-journal --user

使用方法

决定您希望放置网站文件的目录。例如:/home/user/home_journal

home-journal --init --site-directory /home/user/home_journal

每次使用带有--init标志运行home-journal时,它将复制源树中的css、js和图标到网站中。如果这些文件已在网站目录中自定义,则再次使用--init标志时,这些更改将被覆盖。

在稳定版本可用之前,css和js文件可能会更改,因此需要使用--init标志运行。欢迎将css和js文件的改进作为拉取请求提交到仓库。

帮助

usage: home-journal [-h] [-i] [-l {debug,info,warning,error,critical}] [-f LOG_FILE] [-p PORT] -s SITE_DIRECTORY [-t TAGS]

options:
  -h, --help            show this help message and exit
  -i, --init            Initialize the site with css, js, and icons
  -l {debug,info,warning,error,critical}, --log_level {debug,info,warning,error,critical}
                        Log level
  -f LOG_FILE, --log_file LOG_FILE
                        Log file
  -p PORT, --port PORT  Port to run the server on
  -s SITE_DIRECTORY, --site_directory SITE_DIRECTORY
                        Path to the site directory
  -t TAGS, --tags TAGS  A list of tags for new posts

在容器中

尽管目前尚无容器可用,但仓库中提供了示例容器文件。

容器需要python、ffmpeg和libmagic。

使用fedora的一个示例

FROM registry.fedoraproject.org/fedora-minimal:38

RUN dnf5 install -y https://download1.rpmfusion.org/free/fedora/rpmfusion-free-release-38.noarch.rpm && \
    dnf5 install -y \
        python3 \
        python3-pip \
        ffmpeg && \
    dnf5 clean all -y

RUN pip install --root-user-action=ignore \
        home-journal==0.0.8

构建

podman build  -f Containerfile --tag home-journal

运行

podman run --volume /home/user/site:/mnt/site --publish 9000:8000 home-journal \
    home-journal --log_file /mnt/site/hj.log \
        --log_level debug \
        --site_directory /mnt/site \
        --tags family,friends,food,home,travel \
        --init

其中/home/user/site是您希望放置网站文件和日志文件的目录。

请查看仓库根目录中的单个文件,以获取最新的示例。

谢谢

项目详情


下载文件

下载您平台上的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源分布

home_journal-0.0.8.tar.gz (471.5 kB 查看哈希值)

上传时间

构建分布

home_journal-0.0.8-py3-none-any.whl (483.8 kB 查看哈希值)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面