mirror of
https://github.com/docmost/docmost
synced 2025-03-28 21:13:28 +00:00
Update readme
* Rename storage volume
This commit is contained in:
parent
52017b60ca
commit
681a21a238
@ -1,6 +1,6 @@
|
|||||||
FROM node:21-alpine AS base
|
FROM node:21-alpine AS base
|
||||||
|
|
||||||
FROM base as builder
|
FROM base AS builder
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
@ -10,7 +10,7 @@ RUN npm install -g pnpm
|
|||||||
RUN pnpm install --frozen-lockfile
|
RUN pnpm install --frozen-lockfile
|
||||||
RUN pnpm build
|
RUN pnpm build
|
||||||
|
|
||||||
FROM base as installer
|
FROM base AS installer
|
||||||
|
|
||||||
RUN apk add --no-cache curl bash
|
RUN apk add --no-cache curl bash
|
||||||
|
|
||||||
|
85
README.md
85
README.md
@ -1,60 +1,35 @@
|
|||||||
|
<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>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
<br />
|
||||||
|
|
||||||
## Description
|
> [!NOTE]
|
||||||
WIP
|
> Docmost is currently in **beta**. We value your feedback as we progress towards a stable release.
|
||||||
|
|
||||||
## Installation
|
## Getting started
|
||||||
Make sure you have pnpm installed `npm install -g pnpm`
|
To get started with Docmost, please refer to our [documentation](https://docmost.com/docs).
|
||||||
|
|
||||||
```bash
|
## Features
|
||||||
$ git clone https://github.com/docmost/docmost
|
- Real-time collaboration
|
||||||
$ pnpm install
|
- Spaces
|
||||||
```
|
- Permissions management
|
||||||
|
- Groups
|
||||||
|
- Comments
|
||||||
|
- Page history
|
||||||
|
- Search
|
||||||
|
- File attachment
|
||||||
|
|
||||||
## Running the app
|
#### 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>
|
||||||
|
|
||||||
### Development
|
### Contributing
|
||||||
|
See the [development doc](https://docmost.com/docs/self-hosting/development)
|
||||||
#### Frontend
|
|
||||||
```bash
|
|
||||||
$ pnpm nx run client:dev
|
|
||||||
```
|
|
||||||
#### Backend
|
|
||||||
```bash
|
|
||||||
# build extension package first
|
|
||||||
$ nx run @docmost/editor-ext:build
|
|
||||||
|
|
||||||
# development
|
|
||||||
$ pnpm nx run server:start
|
|
||||||
|
|
||||||
# watch mode
|
|
||||||
$ pnpm nx run server:start:dev
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
### Production
|
|
||||||
```bash
|
|
||||||
$ pnpm run build
|
|
||||||
|
|
||||||
$ pnpm nx run server:start:prod
|
|
||||||
```
|
|
||||||
The server will be available on `http://localhost:3000`
|
|
||||||
|
|
||||||
## Migrations
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# This creates a new empty migration file named 'init'
|
|
||||||
$ pnpm nx run server:migration:create init
|
|
||||||
|
|
||||||
# Generates 'init' migration file from existing entities to update the database schema
|
|
||||||
$ pnpm nx run server:migration:generate init
|
|
||||||
|
|
||||||
# Runs all pending migrations to update the database schema
|
|
||||||
$ pnpm nx run server:migration:run
|
|
||||||
|
|
||||||
# Reverts the last executed migration
|
|
||||||
$ pnpm nx run server:migration:revert
|
|
||||||
|
|
||||||
# Shows the list of executed and pending migrations
|
|
||||||
$ pnpm nx run server:migration:show
|
|
||||||
|
|
||||||
```
|
|
||||||
|
@ -2,7 +2,7 @@ version: '3'
|
|||||||
|
|
||||||
services:
|
services:
|
||||||
docmost:
|
docmost:
|
||||||
image: docker.io/library/docmost:latest
|
image: docmost/docmost:latest
|
||||||
depends_on:
|
depends_on:
|
||||||
- db
|
- db
|
||||||
- redis
|
- redis
|
||||||
@ -11,12 +11,11 @@ services:
|
|||||||
APP_SECRET: 'REPLACE_WITH_LONG_SECRET'
|
APP_SECRET: 'REPLACE_WITH_LONG_SECRET'
|
||||||
DATABASE_URL: 'postgresql://postgres:password@db:5432/docmost?schema=public'
|
DATABASE_URL: 'postgresql://postgres:password@db:5432/docmost?schema=public'
|
||||||
REDIS_URL: 'redis://redis:6379'
|
REDIS_URL: 'redis://redis:6379'
|
||||||
STORAGE_DRIVER: 'local'
|
|
||||||
ports:
|
ports:
|
||||||
- "3000:3000"
|
- "3000:3000"
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
volumes:
|
volumes:
|
||||||
- local_storage:/app/data/storage
|
- docmost:/app/data/storage
|
||||||
|
|
||||||
db:
|
db:
|
||||||
image: postgres:16-alpine
|
image: postgres:16-alpine
|
||||||
@ -35,6 +34,6 @@ services:
|
|||||||
- redis_data:/data
|
- redis_data:/data
|
||||||
|
|
||||||
volumes:
|
volumes:
|
||||||
local_storage:
|
docmost:
|
||||||
db_data:
|
db_data:
|
||||||
redis_data:
|
redis_data:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user