{"repo":"Coooolfan/UniBoard","free":true,"listed":false,"github":"https://github.com/Coooolfan/UniBoard","clone":"git clone https://github.com/Coooolfan/UniBoard.git","description":"个人介绍，导航页、笔记、短链、文件分享、探针，私有化部署。Profile、Note、ShortURL、FileSharing、probeMonitor…… with self-host","language":"Vue","stars":243,"topics":["file-sharing","notes","profile","self-hosted","short-url"],"license":"MIT","category":"self-hosted-apps","readme_excerpt":"UniBoard 个人主页 + 导航页 + 笔记 + 短链接 + 文件分享 此仓库使用 monorepo 管理前后端：前端位于 web/ ，使用 Vue + TS + PrimeVue + Tailwind CSS 构建；后端位于 server/ ，使用 Spring Boot + Kotlin + Jimmer ORM 构建。 功能介绍 - 首页个人信息与横幅展示 - 所有内容可编辑 - 允许完全隐藏 - 导航页的外链展示与跳转 - 账号密码登录 - 在主页单击名字，账号密码输入框会弹出 - 云笔记模块 - 支持 Markdown 语法 - 支持所见即所得编辑 - 自带图床服务 - 支持分享密码与纯文本直链 - 短链服务 - 统计 - 文件 - 存储 - 分享 - 直链下载 - 鉴权 - 全局暗色模式支持 截图 着陆页 主页 or 文件分享页 部署与安装 Docker Compose 1. 下载 .env 文件和 docker-compose.yml 文件 2. 按照需要修改 .env 文件和 docker-compose.yml 1. docker-compose.yml ：默认只暴露 8888 端口（文件第6行），通过此端口向外暴露所有服务，如果您需要对 uniboard 配置反向代理，只需代理此端口即可。 2. .env ：按照提示修改即可，切记要修改 POSTGRES PASSWORD 的值， 不要使用默认值! 3. 修改完成后复制 example.env 为 .env 文件,供 docker compose 服务调取 3. 使用 docker compose 命令启动服务 4. 使用浏览器访问站点，默认为 8888 端口，如果您在本机部署，访问 http://localhost:8888 即可 使用Nginx配置反向代理(可选) Uniboard程序本身不提供ssl相关功能，直接暴露8888端口不是一个好的选择。 考虑到不同环境下Nginx的配置可能并不相同，下文仅提供思路和必要配置。 1. 创建对应站点的conf文件 2. 编辑监听的server name, ssl相关内容 3. 配置反向代理 4. 让Nginx重新加载配置 升级 [!CAUTION] 0.3.0 版本与以前版本 完全不兼容 ，重写了整个后端服务。当您尝试“升级”到 0.3.0 及以上版本时，需要删除原所有内容，从0开始。 程序会尝试兼容旧版本的数据库。在 跨多个版本升级 时，建议先浏览 Releases 或者 更新说明页面，查看每个版本的更新内容，以及可能的数据库变更和破坏性更新。 不建议使用各种自动升级工具。 如果您使用上述的 Docker Compose 方式部署，可以通过以下命令升级并重启： API 可见： 与笔记相关的API说明 1. 获取笔记纯文本内容 GET /api/note/ ?pw= ：匿名获取笔记纯文本内容。笔记密码为空时表示私有；密码长度需大于 8 才有效。笔记不存在、私有、密码无效或密码错误时均返回 404 。 与文件相关的API说明 1. 上传文件 POST /api/file-record/files ：上传文件，使用 multipart/form-data 格式，其中 insert 为文件记录信息， file 为二进制文件。返回新增成功的 FileRecord 对象，包含服务端生成的 shareCode 字段。（此方法需要鉴权） 1. 编辑文件信息 PUT /api/file-record/ ：编辑文件信息，参数为文件记录更新对象，返","default_branch":null,"files":null,"tree":[],"storefront":"/r/Coooolfan","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Coooolfan/UniBoard/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}