MinDoc: Documentation and note-taking system for IT teams

As an IT practitioner, I am accustomed to using markdown to write, whether in a company team or writing some notes, blogs and other documents myself. After using many systems or software that support markdown syntax (such as Typora, Unknown, Wolai, Siyuan, Midao, etc.), I always feel that they cannot meet my needs. Until I discovered MinDoc, a simple and easy-to-use open source document management system developed for IT teams. We will introduce this project and how to use docker-compose to quickly deploy it.

Introduction to MinDoc

For a detailed introduction to the project, you can refer to the official website documents

Official website address: https://www.iminho.me/

Project address: https://github.com/mindoc-org/mindoc

Document address: https://www.iminho.me/wiki/docs/mindoc/mindoc-summary.md

Demo site: http://doc.iminho.me

Test user: admin Password: 123456

Deploy MinDoc

Step 1: Install Docker and Docker Compose

If you don't have Docker and Docker Compose installed yet, you need to install them first. The installation guide for your operating system can be found on the official website.

Step 2: Create databasemindoc_db

Prepare a mysql database. If there is no mysql database, you can refer to our previous article to 使用 Docker Compose 部署 MySQL 8.0 build it. After setting up, create a database.mindoc_db

Step 3: Create Docker Compose file

docker-comopose.yml

version: "3.3"
services:
  mindoc:
    image: registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1
    environment:
      TZ: Asia/Shanghai
    restart: always
    ports:
      - "8181:8181"
    volumes:
      - ./data/mindoc/conf:/mindoc/conf
      - ./data/mindoc/static:/mindoc/static
      - ./data/mindoc/views:/mindoc/views
      - ./data/mindoc/uploads:/mindoc/uploads
      - ./data/mindoc/runtime:/mindoc/runtime
      - ./data/mindoc/database:/mindoc/database
    environment:
      - MINDOC_RUN_MODE=prod
      - MINDOC_DB_ADAPTER=mysql
      - MINDOC_DB_HOST=192.168.10.106
      - MINDOC_DB_PORT=3306
      - MINDOC_DB_DATABASE=mindoc_db
      - MINDOC_DB_USERNAME=root
      - MINDOC_DB_PASSWORD=123456
      - MINDOC_CACHE=true
      - MINDOC_CACHE_PROVIDER=file
      - MINDOC_ENABLE_EXPORT=true

Step 4: Launch MinDoc

In the folder containing the docker-compose.yml file, open a terminal or command prompt and run the following command to start MinDoc:

docker-compose up -d 

Step 5: Complete MinDoc deployment

After startup, set the permissions of the mounted folder data

chmod -R 777 data

Access the system address http://192.168.10.108:8181/Default
user: admin Password: 123456

Introduction to use

For specific function introduction, you can read the official website documentation. I prefer its md editor’s support for HTML tags, support for flow charts, mind maps, etc., restoration and merging of historical versions, and multi-level navigation functions.

• HTML tags

• mind Mapping

• flow chart

• historic version