开源协作开发者内容平台Vrite

news/2024/10/23 9:36:20/

在这里插入图片描述

什么是 Vrite ？

Vrite 是一个开源协作空间，用于创建、管理和部署产品文档、技术博客和知识库。它旨在提供高质量、集成的用户和开发人员体验。

Vrite 具有以下功能：

  • 内置管理仪表板，用于使用看板或列表视图管理内容生产和交付；
  • 现代所见即所得编辑体验，支持 Markdown、集成代码编辑器、代码格式化和实时协作；
  • 人工智能驱动的语义搜索，用于组织和搜索您的内容库；
  • 多功能 API和扩展系统，用于定制您的体验并向任何前端交付内容；
  • 开源，可选择自托管和使用Vrite Cloud。

如果不想自己安装，可以在官方站点 ：app.vrite.io上进行体验

安装

在群晖上以 Docker 方式安装。

Vrite 用到 4 个自己官方的镜像，但 tags 最新版本不是常用的 latest，而是 main

还是那句话，如果镜像拉不动，去docker 代理网站试试 ：https://dockerproxy.com/

其中：

  • ghcr.io/vriteio/vrite/api:main ：API
  • ghcr.io/vriteio/vrite/assets:main ：资源
  • ghcr.io/vriteio/vrite/collaboration:main ：协作
  • ghcr.io/vriteio/vrite/app:main ：主程序
  • gmongo ：数据库
  • minio/minio ：存储
  • redis ：缓存
  • semitechnologies/weaviate:1.21.2 ：低延迟矢量搜索引擎

Weaviate 是一个低延迟矢量搜索引擎，开箱即用地支持不同的媒体类型（文本、图像等）。它提供语义搜索、问答提取、分类、可定制模型（PyTorch/TensorFlow/Keras）等。Weaviate 在 Go 中从头开始构建，同时存储对象和向量，允许将向量搜索与结构化过滤和容错相结合云原生数据库，所有这些都可以通过 GraphQL、REST 和各种编程语言客户端访问。【墨天轮百科】

docker-compose.yml

将下面的内容保存为 docker-compose.yml 文件

version: "3.9"services:mongodb:image: mongocontainer_name: vrite-mongovolumes:- ./mdata:/data/db#ports:#  - 27017:27017minio:image: minio/miniocontainer_name: vrite-minioenvironment:- MINIO_ROOT_USER=user- MINIO_ROOT_PASSWORD=password#ports:#  - "9000:9000"#  - "9001:9001"command: server --console-address ":9001" /datavolumes:- ./minio:/dataredis:image: rediscontainer_name: vrite-redisvolumes:- ./rdata:/data#ports:#  - "6379:6379"weaviate:image: semitechnologies/weaviate:1.21.2container_name: vrite-weaviate#ports:#  - 8080:8080volumes:- ./weaviate:/var/lib/weaviateenvironment:- PORT=8080- QUERY_DEFAULTS_LIMIT=25- PERSISTENCE_DATA_PATH=/var/lib/weaviate- DEFAULT_VECTORIZER_MODULE=text2vec-openai- ENABLE_MODULES=text2vec-openai- AUTHENTICATION_APIKEY_ENABLED=true- AUTHENTICATION_APIKEY_ALLOWED_KEYS=password- AUTHENTICATION_APIKEY_USERS=vriteapi:image: ghcr.io/vriteio/vrite/api:maincontainer_name: vrite-apienv_file: ./env.txtdepends_on:- mongodb- redisenvironment:- PORT=4444ports:- "4444:4444"assets:image: ghcr.io/vriteio/vrite/assets:maincontainer_name: vrite-assetsenv_file: ./env.txtdepends_on:- mongodb- minio- redisenvironment:- PORT=8888ports:- "8888:8888"collab:image: ghcr.io/vriteio/vrite/collaboration:maincontainer_name: vrite-collabenv_file: ./env.txtdepends_on:- mongodb- redisenvironment:- PORT=5555ports:- "5555:5555"app:image: ghcr.io/vriteio/vrite/app:maincontainer_name: vrite-appenv_file: ./env.txtenvironment:- PORT=3333ports:- "3333:3333"depends_on:- api- assets- collab- mongodb- minio- redis

env.txt

将下面的内容保存为 env.txt，该文件包含其中的服务 docker-compose.yml 将读取的所有配置选项。

# Basic (required)
HOST=0.0.0.0
NODE_ENV=production# Cookies (optional - multi-domain setup)
COOKIE_DOMAIN=192.168.0.197# Security (required - JWT)
SECRET=a5nWSvHrQrql3pCkdA6bEWMcpvyaQQEr6# MongoDB (required)
MONGO_URL=mongodb://mongodb:27017/vrite# Redis (required)
REDIS_URL=redis://redis:6379# Email (required)
SENDER_EMAIL=wbsu2003@88.com
SENDER_NAME=laosu# One of following required:# Email (SMTP)
SMTP_HOST=smtp.88.com
SMTP_PORT=465
SMTP_USERNAME=wbsu2003@88.com
SMTP_PASSWORD=<邮件的第三方客户端密码>
SMTP_SECURE=false# Email (SendGrid)
SENDGRID_API_KEY=# S3 (required - file storage)
S3_BUCKET=vrite-images
S3_ENDPOINT=http://minio:9000
S3_REGION=us-east-1
S3_ACCESS_KEY=user
S3_SECRET_KEY=password
S3_FORCE_PATH_STYLE=true# Service URLs (required)
PUBLIC_COLLAB_URL=http://192.168.0.197:5555
PUBLIC_APP_URL=http://192.168.0.197:3333
PUBLIC_API_URL=http://192.168.0.197:4444
PUBLIC_ASSETS_URL=http://192.168.0.197:8888# GitHub OAuth2 (optional - GitHub sign in)
GITHUB_CLIENT_ID=
GITHUB_CLIENT_SECRET=# GitHub App (optional - GitHub Git sync)
GITHUB_APP_ID=
GITHUB_APP_PRIVATE_KEY=
GITHUB_APP_CLIENT_ID=
GITHUB_APP_CLIENT_SECRET=# Search (optional - Search)
WEAVIATE_API_KEY=password
WEAVIATE_URL=http://weaviate:8080# AI (optional - AI "Q&A" search)
# OPENAI_API_KEY=
# OPENAI_ORGANIZATION=

下面这些内容是必须设置的：

  • COOKIE_DOMAIN：因为用在局域网使用，所以这里用了 IP 而不是域名；
  • SECRET：可以用 openssl rand -base64 32 来生成；
  • SMTP_：老苏还是用的 88 邮箱，如果不设置或者设置错误，会不能登录；
  • PUBLIC_：是服务的对外地址，所以在局域网使用，所以用的是 IP + 端口的模式；
  • 其他的根据需要设置，请参考官方文档：https://docs.vrite.io/self-hosting/configuration/

然后执行下面的命令

# 新建文件夹 vrite 和 子目录
mkdir -p /volume1/docker/vrite/{mdata,minio,rdata,weaviate}# 进入 vrite 目录
cd /volume1/docker/vrite# 将 docker-compose.yml 和 env.txt 放入当前目录# 一键启动
docker-compose up -d

第一次可能出现这样的情况

在容器 vrite-app 的日志中会看到下面的错误

vrite-app   | 
vrite-app   | /app/index.js:196956
vrite-app   |           const err = new AVV_ERR_READY_TIMEOUT(name2);
vrite-app   |                       ^
vrite-app   | AvvioError [Error]: Plugin did not start in time: 'async (fastify) => { -- const db = fastify.mongo.db;'. You may have forgotten to call 'done' function or to resolve a Promise
vrite-app   |     at Timeout._onTimeout (/app/index.js:196956:23)
vrite-app   |     at listOnTimeout (node:internal/timers:569:17)
vrite-app   |     at process.processTimers (node:internal/timers:512:7) {
vrite-app   |   code: 'AVV_ERR_READY_TIMEOUT',
vrite-app   |   fn: [AsyncFunction (anonymous)] { [Symbol(skip-override)]: true }
vrite-app   | }
vrite-app   | 
vrite-app   | Node.js v18.17.1
vrite-app exited with code 1

似乎是表示某个插件在规定的时间内没有启动完成，因此可以稍等下点后面的开关启动

在这里插入图片描述

当然也可以再次执行

# 再次一键启动
docker-compose up -d

如果能启动成功，就可以开始访问了

【官方提示】：目前，自托管时，Vrite 扩展不可用，因为 Vrite 扩展系统尚未准备好。我们稍后会启用。

运行

在浏览器中输入 http://群晖IP:3333 就能看到登录界面

第一次需要点最下面的 I don't have an account 注册

注册成功后，需要验证邮件

在这里插入图片描述

打开邮件

点邮件中的链接

在这里插入图片描述

点 Go to dashboard，默认是 Kanban 模式，分为 Ideas、Drafts、Published，这个标题是可以修改的

可以切换为 List 模式

在这里插入图片描述

3 个区域的说明

看板区域的说明

在这里插入图片描述

左下角可以切换和新建不同的 workspace

打开示例的 Hello World ，可以修改或者删了重建

Vrite Editor 提供了一种极简主义、所见即所得的编辑体验，并支持 Markdown

老苏重新写了两篇

返回 Dashboard

将完成完成的文档，拖动到 Publish，并且 Lock ，防止被修改，点卡片上的 眼睛就可以预览了，还可以发布到 Dev.to 等平台

更多使用说明，请参考官方的使用指南：https://docs.vrite.io/usage-guide/getting-started/

参考文档

vriteio/vrite: Open-source developer content platform | Now in Public Beta
地址：https://github.com/vriteio/vrite

Vrite － developer content platform
地址：https://vrite.io/

Vrite － developer content platform
地址：https://docs.vrite.io/self-hosting/docker/


http://www.ppmy.cn/news/1129461.html

相关文章

ReactPortals传送门

ReactPortals传送门

ReactPortals传送门 React Portals提供了一种将子节点渲染到父组件以外的DOM节点的解决方案&#xff0c;即允许将JSX作为children渲染至DOM的不同部分&#xff0c;最常见用例是子组件需要从视觉上脱离父容器&#xff0c;例如对话框、浮动工具栏、提示信息等。 描述 <div&…
阅读更多...
Sulfo-CY7 NHS ester荧光染料的合成与化学性质1603861-95-5

Sulfo-CY7 NHS ester荧光染料的合成与化学性质1603861-95-5

Sulfo-CY7 NHS ester的合成通常涉及多个有机合成步骤&#xff0c;包括在荧光染料的分子结构中引入特定的官能团&#xff0c;以确保其荧光性能和生物相容性。以下是Sulfo-CY7 NHS ester的合成和一些相关的化学性质&#xff1a; 合成过程&#xff1a;Sulfo-CY7 NHS ester的合成通…
阅读更多...
MYSQL视图学习

MYSQL视图学习

触发器 触发器&#xff08; trigger &#xff09;&#xff1a;监视某种情况&#xff0c;并触发某种操作&#xff0c;它是提供给程序员和数据分析员来保证数据完整性的 一种方法&#xff0c;它是与表事件相关的特殊的存储过程&#xff0c;它的执行不是由程序调用&#xff0c;也…
阅读更多...
图像处理与计算机视觉--第四章-图像滤波与增强-第一部分

图像处理与计算机视觉--第四章-图像滤波与增强-第一部分

目录 1.灰度图亮度调整 2.图像模板匹配 3.图像裁剪处理 4.图像旋转处理 5.图像邻域与数据块处理 学习计算机视觉方向的几条经验: 1.学习计算机视觉一定不能操之过急&#xff0c;不然往往事倍功半&#xff01; 2.静下心来&#xff0c;理解每一个函数/算法的过程和精髓&…
阅读更多...
缓冲技术在嵌入式中的应用

缓冲技术在嵌入式中的应用

引言 在嵌入式中&#xff0c;不可避免地会遇到数据的收发。 其实&#xff0c;数据的收发有很多情况。 总体上&#xff0c;分为数据的收和发&#xff1a; 其中&#xff0c;数据发送是一个主动的行为&#xff0c;我们对要发送数据的数量特点等都是知道的&#xff0c;比如我们通过…
阅读更多...
爬虫，初学者指南

爬虫，初学者指南

第一篇&#xff1a;爬虫入门request模块的基本使用以www.douban.com为例 get请求&#xff1a; # 查看响应数据&#xff0c;返回的是Unicode格式的数据 print(response.text)# # 查看响应数据&#xff0c;返回的是字节流数据&#xff08;图片视频等&#xff09; print(response…
阅读更多...
【SpringBoot实践】事务和事务传播机制失效原因正确使用事务的建议

【SpringBoot实践】事务和事务传播机制失效原因正确使用事务的建议

文章目录 1.概述2.事务与事务传播2.1 声明式事务说明2.2.声明式事务失效原因2.3.事务的传播机制2.4.事务传播失效原因 3.事务使用建议4.总结 1.概述 我们在开发工作中经常会使用到事务&#xff0c;来保证数据库做增、删、改操作时的数据一致性&#xff0c;在使用Spring来处理事…
阅读更多...
设计模式2、抽象工厂模式 Abstract Factory

设计模式2、抽象工厂模式 Abstract Factory

解释说明&#xff1a;提供一个创建一系列相关或相互依赖对象的接口&#xff0c;而无需指定他们具体的类。 简言之&#xff0c;一个工厂可以提供创建多种相关产品的接口&#xff0c;而无需像工厂方法一样&#xff0c;为每一个产品都提供一个具体工厂 抽象工厂&#xff08;Abstra…
阅读更多...
最新文章

Copyright @ 2022~2023