2018-06-22 15:07:30 -04:00
CodiMD
2015-05-04 03:53:29 -04:00
===
2018-06-22 15:07:30 -04:00
[![#CodiMD on matrix.org][matrix.org-image]][matrix.org-url]
2017-02-15 05:14:58 -05:00
[![build status][travis-image]][travis-url]
2017-10-08 07:15:29 -04:00
[![version][github-version-badge]][github-release-page]
2018-04-11 03:38:45 -04:00
[![POEditor][poeditor-image]][poeditor-url]
2019-05-19 21:10:39 -04:00
[![Mastodon][social-mastodon-image]][social-mastodon]
2015-08-15 00:15:42 -04:00
2019-04-03 17:09:36 -04:00
CodiMD lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [CodiMD demo server][codimd-demo].
2019-03-31 14:10:32 -04:00
2019-03-31 10:02:05 -04:00
It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD ](https://hackmd.io ) and now forked
into its own organisation. [A longer writeup can be read in the history doc ](docs/history.md ).
2015-05-04 03:53:29 -04:00
2019-04-03 17:09:36 -04:00
[][codimd-demo-features]
2015-05-15 00:58:13 -04:00
2017-10-13 03:59:57 -04:00
2019-03-31 10:02:05 -04:00
## Community and Contributions
2017-10-13 03:59:57 -04:00
2019-04-03 17:09:36 -04:00
We welcome contributions! There's a lot to do: If you would like to report bugs,
the [issue tracker][github-issue-tracker] is the right place. If you can help
translating, find us on [POEditor][poeditor-url]. To get started developing,
2019-03-31 10:02:05 -04:00
take a look at the [docs/dev ](docs/dev ) directory. In any case: come talk to us,
we'll be delighted to help you with the first steps.
2016-06-01 12:13:01 -04:00
2019-04-03 17:09:36 -04:00
To stay up to date with our work or get support it's recommended to join our
[Matrix channel][matrix.org-url], stop by our [community forums][codimd-community]
or subscribe to the [release feed][github-release-feed]. We also engage in
2019-04-03 18:34:23 -04:00
regular [community calls][codimd-community-calls] ([RSS](https://community.codimd.org/t/codimd-community-call/19.rss)) which you are very welcome to join.
2018-04-04 19:21:20 -04:00
2019-03-31 10:02:05 -04:00
## Installation / Upgrading
2016-10-04 04:41:26 -04:00
2019-03-31 10:02:05 -04:00
You can run CodiMD in a number of ways, and we created setup instructions for
all of these:
2017-10-08 07:37:20 -04:00
2019-03-31 10:02:05 -04:00
* [Docker ](docs/setup/docker.md )
* [Kubernetes ](docs/setup/kubernetes.md )
* [Cloudron ](docs/setup/cloudron.md )
Fix some minor quirks in the LinuxServer.io 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 LinuxServer.io in the supported provider section of the
README.
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 LinuxServer.io 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 <sheogorath@shivering-isles.com>
2019-06-13 11:41:30 -04:00
* [LinuxServer.io (multi-arch docker) ](docs/setup/docker-linuxserver.md )
2019-03-31 10:02:05 -04:00
* [Heroku ](docs/setup/heroku.md )
2019-06-12 06:46:49 -04:00
* [Manual setup ](docs/setup/manual-setup.md )
2017-10-08 07:37:20 -04:00
2019-03-31 10:02:05 -04:00
If you do not wish to run your own setup, you can find a commercial offering at
https://hackmd.io. This is not the same codebase as this one, but it is a very
similar project.
2015-07-01 12:10:20 -04:00
2016-10-04 04:41:26 -04:00
2019-03-31 10:02:05 -04:00
## Configuration
2016-10-04 04:41:26 -04:00
2019-03-31 10:02:05 -04:00
Theres two main ways to configure your CodiMD instance:
[Config file ](docs/configuration-config-file.md ) or
[environment variables ](docs/configuration-env-vars.md ). You can choose what
works best for you.
2015-05-15 00:58:13 -04:00
2019-03-31 10:02:05 -04:00
CodiMD can integrate with
2016-10-04 04:41:26 -04:00
2019-03-31 10:02:05 -04:00
* facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2 ](docs/guides/auth/oauth.md ) **for login**
* imgur, s3, minio, azure **for image/attachment storage** (files can also be local!)
* dropbox **for export and import**
2018-06-24 07:22:51 -04:00
2019-03-31 10:02:05 -04:00
More info about that can be found in the configuration docs above.
2016-04-20 06:03:55 -04:00
2016-10-04 04:41:26 -04:00
2019-03-31 10:02:05 -04:00
## Browser support
2016-03-14 23:30:43 -04:00
2019-03-31 10:02:05 -04:00
To use CodiMD, your browser should match or exceed these versions:
2015-05-07 23:52:30 -04:00
2019-03-31 10:02:05 -04:00
-  Chrome >= 47, Chrome for Android >= 47
-  Safari >= 9, iOS Safari >= 8.4
-  Firefox >= 44
-  IE >= 9, Edge >= 12
-  Opera >= 34, Opera Mini not supported
- Android Browser >= 4.4
2017-10-08 07:37:20 -04:00
2019-04-03 17:09:36 -04:00
## Related Tools
Our community has created related tools, we'd like to highlight [codimd-cli ](https://github.com/codimd/cli )
which lets you use CodiMD from the comfort of your command line.
2017-10-08 07:37:20 -04:00
# License
2019-03-31 10:02:05 -04:00
Licensed under AGPLv3. For our list of contributors, see [AUTHORS ](AUTHORS ).
2017-03-14 11:30:35 -04:00
2018-06-22 15:07:30 -04:00
[matrix.org-image]: https://img.shields.io/badge/Matrix.org-%23CodiMD@matrix.org-green.svg
[matrix.org-url]: https://riot.im/app/#/room/#codimd:matrix.org
2019-03-28 17:36:26 -04:00
[travis-image]: https://travis-ci.org/codimd/server.svg?branch=master
[travis-url]: https://travis-ci.org/codimd/server
[github-version-badge]: https://img.shields.io/github/release/codimd/server.svg
2019-03-27 14:31:20 -04:00
[github-release-page]: https://github.com/codimd/server/releases
[github-release-feed]: https://github.com/codimd/server/releases.atom
2019-03-31 10:02:05 -04:00
[github-issue-tracker]: https://github.com/codimd/server/issues/
2018-04-16 15:08:24 -04:00
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
2018-04-11 03:38:45 -04:00
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
2019-04-03 17:09:36 -04:00
[codimd-demo]: https://demo.codimd.org
[codimd-demo-features]: https://demo.codimd.org/features
[codimd-community]: https://community.codimd.org
2019-04-03 18:34:23 -04:00
[codimd-community-calls]: https://community.codimd.org/t/codimd-community-call/19
2019-05-19 21:10:39 -04:00
[social-mastodon]: https://social.codimd.org/mastodon
[social-mastodon-image]: https://img.shields.io/badge/social-mastodon-3c99dc.svg
