SelfHostCorner

SelfHostCorner is a community of amazing hobbyists

We're a place where self hosters share, stay up-to-date and expand their knowledge. Join 41 of us!

Create account Log in
Noted
Noted

Posted on • Originally published at noted.lol on

HedgeDoc - A Collaborative Markdown and Note Taking App

HedgeDoc - A Collaborative Markdown and Note Taking App

What's a great self hosted markdown editor where you can collaborate on notes and share them? HedgeDoc!

What is HedgeDoc?

HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor. You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go.

HedgeDoc Core Features

These are the main, core features that make HedgeDoc so great!

Web-based

You don’t need extra software. The editor runs in your browser.

Self-hosted

Stay in control of your data. Keep it on your server.

Real-time collaboration

Collaborate in real-time with friends, family and colleagues.

Presentation mode

Use HedgeDoc to build and present slides in markdown. Powered by reveal.js!

Graphs & diagrams

HedgeDoc supports many types of graphs, diagrams and embedded content.

HedgeDoc - A Collaborative Markdown and Note Taking App
Try the HedgeDoc Demo!

Easy to use permission system

Manage permissions of your notes with a simple drop-down selection.

Revisions

Revisions keep track of changes to your notes and even let you revert to any older version.

Low system requirements

HedgeDoc doesn’t need much resources. It even runs smooth on a Raspberry Pi!

Install HedgeDoc using Docker Compose

You can easily install and deploy HedgeDoc using this Docker Compose stack.

version: "3"
services:
  mariadb:
    image: lscr.io/linuxserver/mariadb:latest
    container_name: hedgedoc_mariadb
    restart: always
    volumes:
      - /docker/hedgedoc/db:/config
    environment:
      - MYSQL_ROOT_PASSWORD=SuperS3cretP@ss
      - MYSQL_DATABASE=hedgedoc
      - MYSQL_USER=hedgedoc
      - MYSQL_PASSWORD=SuperS3cretP@ss
      - PGID=1000
      - PUID=1000
      - TZ=America/Denver
  hedgedoc:
    image: lscr.io/linuxserver/hedgedoc:latest
    container_name: hedgedoc
    restart: always
    depends_on:
      - mariadb
    volumes:
      - /docker/hedgedoc:/config
    environment:
      - DB_HOST=mariadb
      - DB_USER=hedgedoc
      - DB_PASS=SuperS3cretP@ss
      - DB_NAME=hedgedoc
      - DB_PORT=3306
      - PGID=1000
      - PUID=1000
      - TZ=America/Denver
      - CMD_DOMAIN=192.168.0.1
      - CMD_URL_ADDPORT=true #optional
      - CMD_PROTOCOL_USESSL=false #optional
      - CMD_PORT=3000 #optional
    ports:
      - "3000:3000"

Enter fullscreen mode Exit fullscreen mode

You might have to change some volumes and the CMD_DOMAIN to your server IP or domain name. For more detailed installation instructions, please see the HedgeDoc documentation website.

You can then go to the server IP on port 3000 to create a user account and begin creating notes.

HedgeDoc - A Collaborative Markdown and Note Taking App

Sometimes I use HedgeDoc to mock-up posts for Noted. I can easily copy and paste the content over to Ghost when I am finished.

HedgeDoc - A Collaborative Markdown and Note Taking App

Final Notes and Thoughts

HedgeDoc can be used for simple notes to very complex notes, to-do lists, slideshows, presentations and more. HedgeDoc is a powerful tool for those looking for a note taking app that is easy to use but packs a ton of valuable features.

If you find HedgeDoc useful, be sure to give it a star on the HedgeDoc Github repo!

Top comments (0)