# CodiMD Documentation

- [CodiMD Documentation](/s/codimd-documentation)
- [GitHub Repository](https://github.com/hackmdio/codimd) [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](/s/codimd-manual-deployment).

- [Docker Deployment](/s/codimd-docker-deployment)
- [Heroku One Click Deployment](/s/codimd-heroku-deployment)
- [Scalingo One Click Deployment](/@codimd/scalingo-deployment)

<!-- - [Kubernetes Helm Deployment](/s/codimd-kubernetes-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](/s/codimd-configuration).

- ### Overview
- [CodiMD Configuration](/s/codimd-configuration)

- ### Authentication Guides
- #### Single Sign-On
- [SAML](/s/codimd-auth-saml)
- [SAML - OneLogin as example](/s/codimd-auth-saml-onelogin)
- [Active Directory (LDAP)](/s/codimd-auth-active-directory)

- #### OAuth
- [OAuth - GitHub](/s/codimd-oauth-github)
- [OAuth - GitLab](/s/codimd-oauth-gitlab)
- [OAuth - Mattermost](/s/codimd-oauth-mattermost)
- [OAuth - Nextcloud](/s/codimd-oauth-nextcloud)
- [OAuth - Twitter](/s/codimd-oauth-twitter)
- [OAuth - Callback URLs](/s/codimd-oauth-callback-urls)

- ### Image Storage
- [Store Image on S3](/s/codimd-image-storage-S3)
- [Store Image on Minio](/s/codimd-image-storage-minio)

- ### Other Customization
- [Customize Pre-load Terms of Use or Privacy Policy](/s/codimd-preload-notes)

Upgrading and Migration
---
- [Upgrading CodiMD](/s/codimd-upgrade)
- [CodiMD Migrations and Version Changes](/s/codimd-migration-and-changes)
- [Etherpad-lite Migration Guide](/s/codimd-migration-etherpad)

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](/s/codimd-manual-deployment)
- [Database Connection Guide](/s/codimd-db-connection)
- [Project Structure](/s/codimd-project-structure)
- [Webpack](/s/codimd-webpack)

Release Notes
---

- [CodiMD Release Notes](/@codimd/release-notes)

---
###### tags: `CodiMD` `Docs` `book`