hopgoldy/cube-diary

一个简单扁平的桌面 / 移动端日记本。

cube-diary

一个简单扁平的桌面 / 移动端记事本。基于 react / koa2 / sqlite / typescript / antd。

查看桌面端截图

查看移动端截图

特性

• 🚫 无广告、无收费、完全开源，自己的数据自己掌握
• 🚀 极其简单的部署，仅需两行命令
• 🧩 自定义 JSON 导入导出
• 📝 支持 MarkDown 语法，支持实时预览、自动保存、颜色标记
• 🔗 支持笔记内图片、文件上传
• 📱 桌面端 / 移动端全站响应式设计
• 🎯 支持关键字搜索
• 🤖 支持多用户使用
• 🌙 黑夜模式

部署

1. docker 安装（推荐）

cube-diary 不需要 docker compose，单容器即可运行：

docker run -d -p 3700:3700 -v ~/cube-diary-storage:/app hopgoldy/cube-diary:1.0.4

执行后数据将会存放在 ~/cube-diary-storage 目录。

2. npm 安装

cube-diary 在开发时就以简单部署为目标，不需要配置数据库，不需要安装任何软件。仅需 node（16+）环境即可运行。

# 安装项目
# linux 下安装失败时请尝试 sudo 并在安装命令后追加 --unsafe-perm=true --allow-root 参数
npm install -g cube-diary

# 启动项目
cube-diary run

项目启动后将会在当前目录下生成 config.json，可以通过修改该文件来对应用进行简单的自定义。

服务将默认开启在端口 3700 上，可以通过 cube-diary run --port=3701 修改端口。

使用 -h 参数查看更多配置

数据迁移

所有数据均默认保存在应用目录下的 .storage 文件夹里，所以直接将其打包然后复制到其他地方即可。

贡献

本项目系本人自用开发，如果你觉得有些功能不够完善，欢迎 PR / issue。

许可

本项目源码基于 GPL v3 许可开源，点此 查看更多信息。

cube-diary's Issues

日历列表没有预览， 只有日期

找了一圈， 没找到设置的地方

想问 如何打开预览？

一个示例的 `docker-compose.yaml` 文件

version: '3'
services:
  cube-diary:
    image: node:slim
    container_name: cube-diary
    ports:
      - 3700:3700
    volumes:
      - .:/app
    working_dir: /app
    command: >
      sh -c "cd /app &&
             npm install -g cube-diary &&
             cube-diary run"

放到任意目录之后， 执行 sudo docker compose up -d 即可启动。

成功启动之后的目录是这样的：

.
├── config.json
├── docker-compose.yaml
└── .storage
    ├── cube-diary.db
    ├── dbVersion
    ├── jwtSecret
    └── replayAttackSecret

1 directory, 6 files

Fe 希望可以不用登录也可以查看日志

希望可以不用登录也可以查看日志，登陆后才可以添加日志
TKS

希望增加一个https

希望能增加https配置，不然公网都不敢开放呀