# docmost

**Repository Path**: mzzhref/docmost

## Basic Information

- **Project Name**: docmost
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: AGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-11-09
- **Last Updated**: 2025-11-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<div align="center">
    <h1><b>Docmost</b></h1>
    <p>
        Open-source collaborative wiki and documentation software.
        <br />
        <a href="https://docmost.com"><strong>Website</strong></a> | 
        <a href="https://docmost.com/docs"><strong>Documentation</strong></a> |
        <a href="https://twitter.com/DocmostHQ"><strong>Twitter / X</strong></a>
    </p>
</div>
<br />

## 📚 项目文档

本项目包含完整的开发文档，位于 `doc/` 目录：

- [📖 文档索引](./doc/00-文档索引.md) - 文档导航和快速开始
- [📋 项目概述](./doc/01-项目概述.md) - 项目介绍、特性和技术栈
- [🏗️ 架构设计](./doc/02-架构设计.md) - 系统架构和技术设计
- [💻 开发指南](./doc/03-开发指南.md) - 开发环境设置和开发流程
- [🚀 部署指南](./doc/04-部署指南.md) - 部署和运维指南
- [⚙️ 环境变量配置](./doc/05-环境变量配置.md) - 环境变量详细说明
- [📡 API 文档](./doc/06-API文档.md) - API 接口文档

## Getting started

### 快速开始

1. **安装依赖**
   ```bash
   npm install -g pnpm@10.4.0
   pnpm install
   ```

2. **配置环境变量**
   
   在项目根目录创建 `.env` 文件：
   ```env
   DATABASE_URL=postgresql://docmost:password@localhost:5432/docmost?schema=public
   REDIS_URL=redis://localhost:6379
   APP_SECRET=your-very-long-secret-key-at-least-32-characters
   APP_URL=http://localhost:3000
   ```

3. **设置数据库**
   ```bash
   # 创建数据库
   createdb docmost
   
   # 运行迁移
   cd apps/server
   pnpm migration:up
   ```

4. **启动开发服务器**
   ```bash
   # 同时启动前端和后端
   pnpm dev
   
   # 或分别启动
   pnpm client:dev  # 前端 (默认 http://localhost:5173)
   pnpm server:dev  # 后端 (默认 http://localhost:3000)
   ```

5. **访问应用**
   
   打开浏览器访问 `http://localhost:3000`

### Docker 快速部署

```bash
# 使用 Docker Compose
docker-compose up -d
```

更多部署选项请参考 [部署指南](./doc/04-部署指南.md)。

### 详细文档

- 开发环境设置: [开发指南](./doc/03-开发指南.md)
- 部署说明: [部署指南](./doc/04-部署指南.md)
- API 使用: [API 文档](./doc/06-API文档.md)
- 环境变量: [环境变量配置](./doc/05-环境变量配置.md)

To get started with Docmost, please refer to our [documentation](https://docmost.com/docs) or try our [cloud version](https://docmost.com/pricing) .

## Features

- Real-time collaboration
- Diagrams (Draw.io, Excalidraw and Mermaid)
- Spaces
- Permissions management
- Groups
- Comments
- Page history
- Search
- File attachments
- Embeds (Airtable, Loom, Miro and more)
- Translations (10+ languages)

### Screenshots

<p align="center">
<img alt="home" src="https://docmost.com/screenshots/home.png" width="70%">
<img alt="editor" src="https://docmost.com/screenshots/editor.png" width="70%">
</p>

### License
Docmost core is licensed under the open-source AGPL 3.0 license.  
Enterprise features are available under an enterprise license (Enterprise Edition).  

All files in the following directories are licensed under the Docmost Enterprise license defined in `packages/ee/License`.
  - apps/server/src/ee
  - apps/client/src/ee
  - packages/ee

### Contributing

See the [development documentation](https://docmost.com/docs/self-hosting/development)

## Thanks
Special thanks to;

<img width="100" alt="Crowdin" src="https://github.com/user-attachments/assets/a6c3d352-e41b-448d-b6cd-3fbca3109f07" />

[Crowdin](https://crowdin.com/) for providing access to their localization platform.


<img width="48" alt="Algolia-mark-square-white" src="https://github.com/user-attachments/assets/6ccad04a-9589-4965-b6a1-d5cb1f4f9e94" />

[Algolia](https://www.algolia.com/) for providing full-text search to the docs.