Skip to content

zsancc/aurak

Repository files navigation

☁️ Aurak (Aura + Knowledge)

灵动·知识库:让记录像呼吸一样自然,为每一份闪念点亮光环。

Aurak 是一款现代化、极轻量、极速响应的私人专属「云端剪贴板与碎片知识库」。 名字来源于 Aura (灵动、氛围) 与 k (knowledge 知识) 的结合,代表它轻巧如风、无处不在,却能承载你最核心的个人知识财富。

无论是稍后阅读的链接、临时的长文本密码、开发踩坑记录,还是手机到电脑之间需要共享的神秘代码,都可以毫秒级同步到你的私人服务器中保管。绝不把核心数据交接给第三方商业软件。

✨ 核心特性

  • ⚡️ 极速体验:基于最新的 SvelteKit + Svelte 5 (Runes) + Tailwind CSS v4 构建,网页秒开。
  • 📱 完美适配多端:采用精心的响应式设计(Mobile First),并在桌面端提供极客感十足的快捷键及分栏体验。
  • 📦 开箱即用的私有数据库:内嵌超高性能 SQLite + WAL 模式,告别复杂的 MySQL / Redis 配置,所有数据单文件 data/aurak.db 持久化,备份移动极其简单。
  • 🔒 端到端加密支持:针对含密码、私钥等敏感文本的便签,支持单篇“毛玻璃加密”,需要二次密码验证才能查看内容,连管理员看数据库也只能看到密文。
  • 🔗 文件/图片托管:直接拖拽或者粘贴即可上传附件到自己的小服务器。
  • 🔗 链接分享与过期机制:做好的排版不想公开?生成一个一次性或者限时的短链接私密分享给朋友。

🚀 部署指南 (强烈推荐 Docker 一键部署)

为了保证最完美的环境隔离和稳定性,无论你是新手还是老鸟,我们都推荐使用 [Docker & Docker Compose] 进行部署。

1. 准备环境

确保你的服务器已经安装了 Dockerdocker-compose。(如果你使用的是宝塔面板,请在软件商店里直接安装“Docker 管理器”即可)。

2. 获取代码与启动

通过 SSH 登录到你的服务器,或者直接在宝塔面板的「容器 -> 容器编排」里创建模板。 如果你想一键启动,可以直接下载部署文件:

# 下载部署配置文件 (只需这一个文件!)
wget https://raw.githubusercontent.com/zsancc/aurak/main/docker-compose.yml

# (可选但推荐) 编辑 docker-compose.yml,修改你的专属密码
# nano docker-compose.yml
# 找到 ACCESS_CODE (登录密码) 和 PRIVACY_PASSWORD (解锁私密长文的密码) 并修改

# 一键魔法启动!(将自动从 GitHub 镜像库拉取最新版本)
docker-compose up -d

就这么简单! 稍等片刻(自动拉取依赖与编译后),你就可以通过浏览器访问 http://你的服务器IP:7888 了。

🔑 关于密码与端口修改: 打开 docker-compose.yml,在 environment 节点下可以自由修改 ACCESS_CODE (登录密码,默认 aurak2024) 和 PRIVACY_PASSWORD (私签解锁密码,默认 aurak2026)。 另外在 ports 节点可以把左侧的 7888 修改为你想要的访问端口(例如 8080:7888 代表以 8080 端口外网访问)。

✨ 关于数据库初始化的说明: 你会发现我们并没有在仓库里放置默认的数据库文件(因为这是你的私人宝库!)。 当你第一次启动 docker-compose up -d 时,程序会在背后的 ./data 文件夹内自动为你创建一个属于你自己的 aurak.db,并自动执行完毕所有的表结构迁移,真正意义上的“开箱即用”。


💾 数据备份与服务器迁移(如何更新?)

Aurak 是围绕着“个人数据资产神圣不可侵犯”的理念而打造的。你的核心数据全部剥离在了 Docker 容器外部:

  • data/:存放了 SQLite 数据库单文件
  • uploads/:存放了你的图片和文件附件

🔄 如何平滑更新到最新代码?

不需要担心数据丢失。由于挂载卷机制,哪怕应用从 v1 升级到 v2,你只需要执行:

# 拉取基于 GitHub Action 自动编译分发的最新镜像
docker-compose pull
# 用新镜像重新启动容器
docker-compose up -d

重新启动后,代码会自动识别旧的数据库,如果有新功能需要新的字段,它甚至会为你后台静默升级表结构,无需任何人工操作!

🚚 如何搬家到另一台服务器?

只需要用 U 盘或者打包工具,把当前目录下的 data 文件夹、uploads 文件夹和 docker-compose.yml 拷贝到新服务器。 执行 docker-compose up -d,所有笔记、所有的排版、密码和状态瞬间无损满血复活!


🛠 本地开发指南

如果你熟悉前端开发,并且想为 Aurak 贡献代码:

# 安装依赖
npm install

# 启动本地开发热更新服务器(默认 2333 端口)
npm run dev

# 构建生产版本
npm run build

技术栈:Svelte 5 | SvelteKit | Drizzle ORM | Better-Sqlite3 | Tailwind CSS v4

About

Aurak:一款现代化、极轻量、极速响应的私人专属「云端笔记/剪贴板」碎片知识库

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors