summaryrefslogtreecommitdiff
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Add hints about how to be informed about updatesSheogorath2018-11-181-0/+4
| | | | | | | | | | | | 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 versions. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #1053 from dsprenkels/robots.txtChristoph (Sheogorath) Kern2018-11-171-0/+2
|\ | | | | Disallow creation of robots.txt in freeurl
| * Disallow creation of robots.txt in freeurlDaan Sprenkels2018-11-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | 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 <hello@dsprenkels.com>
* | switching to eslint for code checkingClaudius Coenen2018-11-141-4/+0
| | | | | | | | | | | | | | 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 <opensource@amenthes.de>
* | Upgrade winstonSheogorath2018-11-141-0/+2
|/ | | | | | | | | 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 <sheogorath@shivering-isles.com>
* Add full version stringSheogorath2018-11-111-0/+2
| | | | | | | | | | | | 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 <sheogorath@shivering-isles.com>
* Remove Gitter from codebaseSheogorath2018-10-171-3/+0
| | | | | | | | | | 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 <sheogorath@shivering-isles.com>
* Merge pull request #990 from SISheogorath/fix/oauthProviderNameChristoph (Sheogorath) Kern2018-10-091-0/+1
|\ | | | | Make oauth2 provider name accessible
| * Make oauth2 provider name accessibleSheogorath2018-10-041-0/+1
| | | | | | | | | | | | | | | | | | 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 <sheogorath@shivering-isles.com>
* | Update supported node.js versionXaver Maierhofer2018-10-071-1/+1
| | | | | | | | | | | | Support includes v9.x, but no v10.x Signed-off-by: Xaver Maierhofer <xaver.maierhofer@xwissen.info>
* | Merge pull request #940 from WilliButz/fix-configurable-pathsChristoph (Sheogorath) Kern2018-10-051-13/+12
|\ \ | |/ |/| enhance configurabiltiy of paths & make execution path-independent
| * README: add note about configurable pathsWilliButz2018-09-271-13/+12
| | | | | | | | Signed-off-by: WilliButz <wbutz@cyberfnord.de>
* | details about OAuth2 in general. Fixes #930Claudius Coenen2018-10-041-0/+9
|/ | | | Signed-off-by: Claudius Coenen <opensource@amenthes.de>
* Remove dead link from READMESheogorath2018-09-121-3/+0
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Fix typo in linkSheogorath2018-09-061-1/+1
|
* Change to new codimd-container repositorySheogorath2018-09-061-4/+4
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add an auth provider guide for MattermostOndřej Slabý2018-08-281-1/+1
| | | | Signed-off-by: Ondřej Slabý <kron258@gmail.com>
* Add Cloudron as an installation methodGirish Ramakrishnan2018-08-201-0/+7
| | | | | | Fixes #923 Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
* Add possibility to choose between version v3 or v4 for the gitlab api.Cédric Couralet2018-07-311-0/+1
| | | | | | | | 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 <cedric.couralet@gmail.com>
* Support 'host' & 'path' config optionsMiranda Kastemaa2018-07-271-0/+4
| | | | Signed-off-by: Miranda Kastemaa <miranda@foldplop.com>
* Update install instructions to cover sequelizeSheogorath2018-06-261-1/+4
| | | | | | | We instruct people to run db migrations on inital setup. We should do that! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Rename environment variables and add legacy support.Sheogorath2018-06-241-74/+76
| | | | | | | | 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 change. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add background story about the renamingSheogorath2018-06-241-0/+11
| | | | | | | | 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 <sheogorath@shivering-isles.com>
* Rebrand HackMD to CodiMDSheogorath2018-06-241-33/+33
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Allow to disable gravatarSheogorath2018-06-231-0/+2
| | | | | | | | | 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 <sheogorath@shivering-isles.com>
* Fix possible error if HackMD is started with wrong workdirSheogorath2018-06-231-0/+1
| | | | | | | | | | In https://github.com/hackmdio/hackmd/issues/834 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 <sheogorath@shivering-isles.com>
* Merge pull request #844 from hackmdio/docs/fix-defaultChristoph (Sheogorath) Kern2018-06-181-2/+2
|\ | | | | Fix wrong docs about default image upload location
| * Fix wrong docs about default image upload locationSheogorath2018-06-171-2/+2
| | | | | | | | | | | | | | | | 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 <sheogorath@shivering-isles.com>
* | Add K8s note in READMESheogorath2018-06-171-0/+7
|/ | | | | | | 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 <sheogorath@shivering-isles.com>
* Add Azure Blob Storage supportÁdám Hóka2018-06-011-2/+4
| | | | Signed-off-by: Adam Hoka <hoka.adam@nexogen.hu>
* Removing google drive integrationSheogorath2018-05-161-1/+1
| | | | | | | | | | | | | | | 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 go. 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 <sheogorath@shivering-isles.com>
* Fix possible file limit errorsSheogorath2018-04-161-2/+1
| | | | | | | | | | | | | | | 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 <sheogorath@shivering-isles.com> [1]: https://github.com/webpack-contrib/copy-webpack-plugin/issues/59#issuecomment-228563990 [2]: https://github.com/thegcat
* Extend READMESheogorath2018-04-111-0/+4
| | | | | | | Add hint about file descriptor limits and add the new translation platform. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge branch 'feature/releaseNotes1.1.0'Sheogorath2018-04-061-2/+9
|\
| * Add migration section to README.mdSheogorath2018-04-061-2/+9
| | | | | | | | | | | | | | As it was requested to be more visable, this commit adds a migration section about the introduced config style changes. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* | Add session data to env varsSheogorath2018-03-291-0/+2
|/ | | | | | | | | | | 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 <sheogorath@shivering-isles.com>
* Change config to camel case with backwards compatibilitySheogorath2018-03-251-36/+36
| | | | | | | | This refactors the configs a bit to now use camel case everywhere. This change should help to clean up the config interface and make it better understandable. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add config option for report URI in CSPSheogorath2018-03-141-0/+1
| | | | | | | | This option is needed as it's currently not possible to add an report URI by the directives array. This option also allows to get CSP reports not only on docker based setup but also on our heroku instances. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Remove unused LDAP option `tokenSecret`Felix Schäfer2018-03-051-1/+0
| | | | | | hackmdio/hackmd#754 Signed-off-by: Felix Schäfer <felix@thegcat.net>
* Introduce ldap.useridFieldDustin Frisch2018-03-011-1/+2
| | | | Signed-off-by: Dustin Frisch <fooker@lab.sh>
* Rerun doctocZearin2018-02-171-2/+2
| | | | Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
* Update README.mdZearin2018-02-171-117/+117
| | | | Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
* Add matrix.org badge to README.mdChristoph (Sheogorath) Kern2018-02-081-0/+3
| | | | | | | | | Matrix.org is an interesting platform for collaboration and community building. Thanks to various clients it supports it's maybe better than gitter to keep people on track and have a community feeling, discuss changes and more. Not not split up into two parties not knowing of each other, the Gitter channel and the Matrix channel are bridged. This helps to keep everyone informed while add more medias. Signed-off-by: Christoph Kern <sheogorath@shivering-isles.com>
* Update Heroku buttonSheogorath2018-01-311-2/+4
| | | | | | | | | The button needs a parameter to work, that provides the git repository that is used for the deployment. This commit corrects the link and this way fixes the provisioning as it's not working with the wrong/default buildpacks. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #707 from Nebukadneza/add_cmdline_usermanagerChristoph (Sheogorath) Kern2018-01-291-2/+2
|\ | | | | Add simple user-management tool for emailsignin
| * Add simple user-management tool for emailsignin …Dario Ernst2018-01-291-2/+2
| | | | | | | | | | | | | | | | | | Currently, administrators of closed instances need to manually fiddle in their databases for user-management. This commit adds a small commandline utility that allows to create and delete users. Signed-off-by: Dario Ernst <dario@kanojo.de>
* | Update badges in README.mdSheogorath2018-01-291-2/+2
|/ | | | | | | The docker badges have to be updated since we now provide official image like tags. So `latest-alpine` became `alpine`. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #705 from SISheogorath/fix/camelcaseConfigChristoph (Sheogorath) Kern2018-01-291-4/+4
|\ | | | | Remove camel case from `imageuploadtype` in config
| * Remove camel case from `imageuploadtype` in configSheogorath2018-01-271-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | This removes the only camel cased option of the config options **we** added to the config.json. In auth provider's config parts are a lot of camel cased options provided. We shouldn't touch them to keep them as similar as possible to the examples. Fixes #315 Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* | Add recommendation for 2GB RAMSheogorath2018-01-261-0/+1
|/ | | | | | | | | | We noticed on multiple places that machines with less than 2GB of RAM fail their build and result in missing files and unexpected errors. Sadly we can't really solve this right now since it's a webpack related bug. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>