Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: New Service CodiMD #4867

Open
wants to merge 5 commits into
base: next
Choose a base branch
from

Conversation

Manaf941
Copy link

Changes

  • Added CodiMD service's docker compose template

About CodiMD

CodiMD is a realtime collaborative markdown editor. You can edit markdown notes at the same time as other. You can then share or publish those documents visible for anyone with the link.

CodiMD is the open-source version of HackMD

GitHub: https://github.com/hackmdio/CodiMD

I personally think it's an important service to have. Self-hosting note taking apps is important to avoid being provider-locked and owning your data. Especially in the AI era, you probably don't want AIs being trained on your content.

Disclaimer

I am not affiliated with the project in any form. I just like CodiMD and Coolify.

Example Deployment

https://md.manaf.ch

Note about environment variables

Since CodiMD's configuration is done primarily through environment variables and not through a settings UI, I tried adding the most basic and general ones to make it work out of the box. However, some people might like it a bit more tweaked.
List of possible environment variables: https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-configuration

Note about security

Registrations are enabled by default. You need to modify the environment variable CMD_ALLOW_EMAIL_REGISTER=true to false to disable it.

@peaklabs-dev peaklabs-dev added the ⚙️ Service Issues requesting or PRs adding/fixing service templates. label Jan 21, 2025
templates/compose/codimd.yaml Outdated Show resolved Hide resolved
- CMD_ALLOW_EMAIL_REGISTER=true
# You're forced to have CMD_ALLOW_EMAIL_REGISTER=true at least once for the first time you create an account
# However, can be safely disabled afterwards
# You can also use the manage_users script to create users: https://github.com/hackmdio/codimd/blob/master/bin/manage_users
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible, register the user via a entrypoint script and environment variables.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the email and password be shown into Coolify's UI ? Should I just generate a random email ?

templates/compose/codimd.yaml Outdated Show resolved Hide resolved
templates/compose/codimd.yaml Show resolved Hide resolved
@peaklabs-dev peaklabs-dev added the 💤 Waiting for changes PRs awaiting changes from the author. label Jan 22, 2025
@peaklabs-dev peaklabs-dev self-assigned this Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙️ Service Issues requesting or PRs adding/fixing service templates. 💤 Waiting for changes PRs awaiting changes from the author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants