Commit graph

188 commits

Author SHA1 Message Date
Sheogorath 788d8ca933
Fix some minor quirks in the docs
The current documents might end up confusing people and are not
completely accessible. This minor fixes should clear up the situation
and add alt texts to all badges, explain the links at the end of the
docs, and list in the supported provider section of the

Some reasoning on the change in the listing:
Since we maintain an own container image which is for sure kept updated
on release, this is our first listing, as well as general solutions that
are build on that image, like the K8s integration.

The next listings are integrated provides which allow self-hosting, like
Cloudron and I also consider as this kind of providers.
Which try to enable people to run CodiMD on their own hardware or rented
servers in a very easy way, but by using their own images.

As third category I would look at hosted offers, like Heroku, which are
not completely SaaS but far enough away from the self-hostability that
I consider them as an own category. PaaS-based solutions are not as
FOSS-style as we want our setups to be, but of course still supported.

Finally the manual setup. We keep it down here, because we support it,
but don't recommend it in general. It's hard to upgrade and can cause
problems when dependencies are not correctly updated or people don't run
the db migrations.

Signed-off-by: Sheogorath <>
2019-08-01 20:03:07 +02:00
chbmb 04d26637d6 Add docker image from as an install option.
As requested by @SISheogorath [here]( and further to discussion about previous PR [here.](

Signed-off-by: Neil Green <>
2019-06-12 11:46:49 +01:00
Amolith b220de8eb1
add mastodon badge - partially fix #70
Signed-off-by: Amolith <>
2019-05-19 21:52:08 -04:00
Claudius Coenen 49539fb27f
tiny correction to url. also adding RSS feed. 2019-04-04 00:34:23 +02:00
Sheogorath e96c8d1dd4
Update community call URL
We have a discourse forum and since it's the place for all kinds of
community organisation, this should be used for organising the community

This patch updates the link to the new topic in the forum.

Signed-off-by: Sheogorath <>
2019-04-03 23:56:31 +02:00
Claudius acd7634fc7 more ways to engage with the community added to the readme
Signed-off-by: Claudius <>
2019-04-03 23:24:05 +02:00
Claudius 54edec8900 striving for consistency across various docs
Signed-off-by: Claudius <>
2019-04-01 01:03:36 +02:00
Claudius edf301cfa3 splitting into files in /docs for better readability
Signed-off-by: Claudius <>
2019-04-01 01:03:36 +02:00
Sheogorath e982ef686c
Add note about changing the upstream repository
People who want to get the latest and greatest version of CodiMD should 
be aware of the repository change. This upgrade note, will hopefully 

Signed-off-by: Sheogorath <>
2019-03-28 22:45:58 +01:00
Sheogorath a5836dd52f
Fix container image links
Signed-off-by: Sheogorath <>
2019-03-28 22:45:58 +01:00
Sheogorath 982a12f569
Fix some remaining references to the old repository
Signed-off-by: Sheogorath <>
2019-03-28 22:45:57 +01:00
Sheogorath 7cde6958f3
Update links to new repositories
After a long discussion, it turned out that CodiMD as community project
and HackMD as a company, have fundamental different views on the project

Due to this, it came to point where the decision for a fork was made.
After the fork and move towards an own organisation, this patch updates
all links inside the project to the new repositories.

Signed-off-by: Sheogorath <>
2019-03-27 19:31:34 +01:00
Turakar 13ee05ba0d Mention dependency on libssl-dev in
This dependency was introduced by upgrading to the new scrypt version in commit cee2aa92f9.

Signed-off-by: Tilman Hoffbauer <>
2019-03-04 20:14:55 +01:00
Jonathan 07697ee9a1 Fix reference to SAML guide in README
Signed-off-by: Jonathan Klauck <>
2019-01-22 10:48:45 +01:00
Sheogorath 62cad26e08
Add hints about how to be informed about updates
Keeping people in the loop about new version of CodiMD is not easy. When
people don't keep an eye on GitHub it's easy to miss new versions.

To help people keeping their software up to date, this patch adds hints
to check out our community channel or simply the GitHub Atom feed
generated for based on the release page to get informed about new

Signed-off-by: Sheogorath <>
2018-11-18 02:16:04 +01:00
Christoph (Sheogorath) Kern 5f0d04334b
Merge pull request #1053 from dsprenkels/robots.txt
Disallow creation of robots.txt in freeurl
2018-11-17 13:30:06 +01:00
Daan Sprenkels 4bd8d7eb91 Disallow creation of robots.txt in freeurl
Add a configuration setting to "hard"-disable creation of notes as
set by the configuration value. This defaults to `['robots.txt',
'favicon.ico']`, because these files are often accidentally created
by bots and browsers.

This commit fixes #1052.

Signed-off-by: Daan Sprenkels <>
2018-11-17 13:23:03 +01:00
Claudius Coenen 858a59529e switching to eslint for code checking
most rules degraded to WARN, so we don't go insane. This will
change over time. The aim is to conform to a common style

Signed-off-by: Claudius Coenen <>
2018-11-14 23:15:36 +01:00
Sheogorath c3584770f2
Upgrade winston
Our log library got a new major version which should be implemented.

That's exactly what this patch does. Implementing the new version of the
logging library.

Signed-off-by: Sheogorath <>
2018-11-14 00:47:11 +01:00
Sheogorath bcc914a773
Add full version string
Currently we only provide the version from `package.json`. This means
that during updates of instances, e.g. the demo instance, which runs
latest master instead of a stable release, changes are not reflected to
the webclient.

This patch adds a fullversion string that contains the current commit
and this way makes that clients are notified about changes.

Signed-off-by: Sheogorath <>
2018-11-11 12:44:19 +01:00
Sheogorath 7d5abadcf7
Remove Gitter from codebase
We no longer use Gitter for development talk and similar. So we might
want to remove it?

This patch removes Gitter from README, help page and features page. And
replaces it in the help modal with POEditor, our translation platform.

Signed-off-by: Sheogorath <>
2018-10-17 02:28:19 +02:00
Christoph (Sheogorath) Kern 5c4df14bbc
Merge pull request #990 from SISheogorath/fix/oauthProviderName
Make oauth2 provider name accessible
2018-10-09 21:57:37 +02:00
Xaver Maierhofer fd54e3f3ac
Update supported node.js version
Support includes v9.x, but no v10.x

Signed-off-by: Xaver Maierhofer <>
2018-10-07 02:33:38 +02:00
Christoph (Sheogorath) Kern 32af96aa37
Merge pull request #940 from WilliButz/fix-configurable-paths
enhance configurabiltiy of paths & make execution path-independent
2018-10-05 22:21:01 +02:00
Sheogorath 3d1d03fa87
Make oauth2 provider name accessible
Right now the feature exists but is almost not usable since the only way
to configure it is to know that it exists from reading the source code
and add it to config.json. This patch provides all needed changes so it
can be used by everyone including documentation.

Signed-off-by: Sheogorath <>
2018-10-04 20:45:25 +02:00
Claudius Coenen 423956c44d details about OAuth2 in general. Fixes #930
Signed-off-by: Claudius Coenen <>
2018-10-04 11:37:48 +02:00
WilliButz 61e240192e
README: add note about configurable paths
Signed-off-by: WilliButz <>
2018-09-27 12:08:29 +02:00
Sheogorath fe977434f9
Remove dead link from README
Signed-off-by: Sheogorath <>
2018-09-12 15:40:20 +02:00
Sheogorath f27e11adab
Fix typo in link 2018-09-06 14:42:08 +01:00
Sheogorath f177cdfbba
Change to new codimd-container repository
Signed-off-by: Sheogorath <>
2018-09-06 14:40:37 +01:00
Ondřej Slabý 6ce7b20a7f Add an auth provider guide for Mattermost
Signed-off-by: Ondřej Slabý <>
2018-08-28 11:00:00 +02:00
Girish Ramakrishnan aa0c4705db Add Cloudron as an installation method
Fixes #923

Signed-off-by: Girish Ramakrishnan <>
2018-08-20 20:42:52 -07:00
Cédric Couralet 66d374b128 Add possibility to choose between version v3 or v4 for the gitlab api.
Apart from the uri versioning, one big change is the snippet visibility post data (visibility_level -> visibility)

Default gitlab api version to v4

Signed-off-by: Cédric Couralet <>
2018-07-31 08:36:56 +00:00
Miranda Kastemaa 70e8df5c04 Support 'host' & 'path' config options
Signed-off-by: Miranda Kastemaa <>
2018-07-27 15:35:29 +03:00
Sheogorath 3b9e29a14a
Update install instructions to cover sequelize
We instruct people to run db migrations on inital setup. We should do

Signed-off-by: Sheogorath <>
2018-06-26 22:56:19 +02:00
Sheogorath b242b59db4
Rename environment variables and add legacy support.
As we are no longer HackMD the short tag `HMD` doesn't match anymore. We
move it to the matching prefix `CMD` and inform our users about the

Signed-off-by: Sheogorath <>
2018-06-24 13:40:18 +02:00
Sheogorath 12d11f3f3f
Add background story about the renaming
We want to communicate transparent. So we should state very clear what
CodiMD is and what makes it different from HackMD and at the same time
how we are related and that there are no bad boys involved.

Signed-off-by: Sheogorath <>
2018-06-24 13:24:13 +02:00
Sheogorath 4b060c7dba
Rebrand HackMD to CodiMD
Signed-off-by: Sheogorath <>
2018-06-24 13:24:12 +02:00
Sheogorath 318b2d378f
Allow to disable gravatar
Since Gravatar is an external image source and not perfect from a
privacy perspective, forbidding it allows to improve privacy.

This commit also simplifies and optimizes the avatar code.

Signed-off-by: Sheogorath <>
2018-06-23 23:40:55 +02:00
Sheogorath a2608c319a
Fix possible error if HackMD is started with wrong workdir
In is described how
starting HackMD crashes when using the wrong working dir.

This is caused by a relative path in our upload routine. This change
should fix it and prevent future crashes.

Signed-off-by: Sheogorath <>
2018-06-23 23:01:01 +02:00
Christoph (Sheogorath) Kern 82c7f9d07c
Merge pull request #844 from hackmdio/docs/fix-default
Fix wrong docs about default image upload location
2018-06-18 03:42:42 +02:00
Sheogorath 10dbd537b4
Fix wrong docs about default image upload location
We wrongly state that the default image upload location is imgur. This
is no longer true, but got lost when updating docs. This commit should
fix it.

Signed-off-by: Sheogorath <>
2018-06-17 23:38:49 +02:00
Sheogorath 6ffe8875bf
Add K8s note in README
We have an official K8s chart for helm out there but probably no one
knows about it. Let's advertise it a bit!

Signed-off-by: Sheogorath <>
2018-06-17 23:38:25 +02:00
Ádám Hóka 376fcab2ca Add Azure Blob Storage support
Signed-off-by: Adam Hoka <>
2018-06-01 10:07:52 +02:00
Sheogorath ad69c5017b
Removing google drive integration
It's sad but it's not working. For multiple releases this should be
already broken which shows how often it's used.

As there is also a security issue related to that, it's better to
remove the feature completely. Whoever wants to rewrite it, feel free to

This commit removes the Google Drive integration from HackMD's Frontend
editor and this way removes the need to provide any API key and Client
ID in the frontend.

Signed-off-by: Sheogorath <>
2018-05-16 01:34:55 +02:00
Sheogorath c4dba48f79
Fix possible file limit errors
As we currently may need higher nofile limits than usual/default on
various systems this commit should probide a fix for that an allow to
build HackMD without highering these limits and increase security.

Inspiration was found in a copy-webpack-plugin-issue[1] and found by
@thegcat[2]. Thanks for that!

Signed-off-by: Sheogorath <>

2018-04-16 21:08:34 +02:00
Sheogorath f23f403bcb
Add hint about file descriptor limits and add the new translation

Signed-off-by: Sheogorath <>
2018-04-11 09:38:56 +02:00
Sheogorath 14a0f8594f
Merge branch 'feature/releaseNotes1.1.0' 2018-04-06 16:24:08 +02:00
Sheogorath 81e5ebf6d6
Add migration section to
As it was requested to be more visable, this commit adds a migration
section about the introduced config style changes.

Signed-off-by: Sheogorath <>
2018-04-06 02:20:34 +02:00
Sheogorath 30b5ff0d96
Add session data to env vars
Currently the session secret can only be set by config.json or docker
secrets. This creates a problem on Heroku hosted instances that can not
set a session secret.

Since we automatically generate them on startup this results in an
logout of all users on every config change in Heroku.

Signed-off-by: Sheogorath <>
2018-03-29 19:34:32 +02:00