Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
* Rename storage volume
  • Loading branch information
Philipinho committed Jun 28, 2024
1 parent 52017b6 commit 681a21a
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 66 deletions.
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
FROM node:21-alpine AS base

FROM base as builder
FROM base AS builder

WORKDIR /app

Expand All @@ -10,7 +10,7 @@ RUN npm install -g pnpm
RUN pnpm install --frozen-lockfile
RUN pnpm build

FROM base as installer
FROM base AS installer

RUN apk add --no-cache curl bash

Expand Down
95 changes: 35 additions & 60 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,35 @@

## Description
WIP

## Installation
Make sure you have pnpm installed `npm install -g pnpm`

```bash
$ git clone https://github.com/docmost/docmost
$ pnpm install
```

## Running the app

### 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

```
<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 />

> [!NOTE]
> Docmost is currently in **beta**. We value your feedback as we progress towards a stable release.
## Getting started
To get started with Docmost, please refer to our [documentation](https://docmost.com/docs).

## Features
- Real-time collaboration
- Spaces
- Permissions management
- Groups
- Comments
- Page history
- Search
- File attachment

#### 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>

### Contributing
See the [development doc](https://docmost.com/docs/self-hosting/development)
7 changes: 3 additions & 4 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: '3'

services:
docmost:
image: docker.io/library/docmost:latest
image: docmost/docmost:latest
depends_on:
- db
- redis
Expand All @@ -11,12 +11,11 @@ services:
APP_SECRET: 'REPLACE_WITH_LONG_SECRET'
DATABASE_URL: 'postgresql://postgres:password@db:5432/docmost?schema=public'
REDIS_URL: 'redis://redis:6379'
STORAGE_DRIVER: 'local'
ports:
- "3000:3000"
restart: unless-stopped
volumes:
- local_storage:/app/data/storage
- docmost:/app/data/storage

db:
image: postgres:16-alpine
Expand All @@ -35,6 +34,6 @@ services:
- redis_data:/data

volumes:
local_storage:
docmost:
db_data:
redis_data:

0 comments on commit 681a21a

Please sign in to comment.