Home

You can find all documentation here:

• CodiMD Documentation

Or follow below table of contents:

Deployment

If you want to spin up an instance and start using immediately, refer to below guides. If you want to contribute to the project, start with [manual deployment].

• Docker Deployment
• Heroku One Click Deployment
• Kubernetes Helm Deployment

Configuration

You can configure CodiMD either with the config file .config.json or with environment variables.

Environment variables overwrites .config.json , which overwrites default settings in ./lib/config/default.js.

See the detailed config precedence here: .lib/config/index.js#37.

• Overview

  • Configuring CodiMD with config.json
  • Configuring CodiMD with Environment Variables

• Authentication

  • Single Sign-On

    • Active Directory (LDAP)
    • SAML
    • SAML - OneLogin as example

  • OAuth

    • OAuth - GitHub
    • OAuth - GitLab
    • OAuth - Mattermost
    • OAuth - Nextcloud
    • OAuth - Twitter
    • OAuth - Callback URLs

• Image Storage

  • Store Image on S3
  • Store Image on Minio

• Other Customization

  • Customize Pre-load Terms of Use or Privacy Policy

Upgrading and Migration

• Upgrading CodiMD
• CodiMD Migrations and Version Changes
• Etherpad-lite Migration Guide

Developer Guides

• CodiMD Manual Deployment
• Project Structure
• Webpack
• Public CodiMD instances