codimd-documentation.md

CodiMD Documentation

• CodiMD Documentation
• GitHub Repository [target=_blank]

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
• Scalingo One Click Deployment

Configuration

CodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in CodiMD Configuration.

• Overview

  • CodiMD Configuration

• Authentication Guides

  • Single Sign-On

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

  • 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

Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, to build your changes with the help of webpack.

• CodiMD Manual Deployment
• Database Connection Guide
• Project Structure
• Webpack

Release Notes

• CodiMD Release Notes

---

tags: CodiMD Docs book