summaryrefslogtreecommitdiff
path: root/README.md (follow)
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* Extend README changes for minioSheogorath2018-01-261-3/+3
|
* Add README and `config.json.example` contentSheogorath2018-01-231-1/+7
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Merge pull request #598 from xxyy/feature/cspChristoph (Sheogorath) Kern2018-01-221-1/+3
|\ | | | | Implement basic CSP support
| * Move CSP logic to new file, Fix boolean config examplesLiterallie2017-10-221-2/+2
| | | | | | | | Not sure why I was quoting these in the first place
| * Change CSP config format to be more intuitiveLiterallie2017-10-221-0/+2
| |
* | Add option to enable `freely` permission in closed instanceDario Ernst2018-01-201-0/+2
| | | | | | | | | | | | | | | | Before, closed disallowed guest edits completely, by removing the `freely` permission. This makes it possible to explicitely bring back guest-editing, but not guest-note-creation, to closed instances. Signed-off-by: Dario Ernst <dario@kanojo.de>
* | Update README.mdMax Wu2018-01-181-1/+1
| | | | | | To show "Community Edition" on title.
* | [ci skip] Add CodeTriage badgeschneems2018-01-031-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | [CodeTriage](https://www.codetriage.com/) is an app I have maintained for the past 4-5 years with the goal of getting people involved in Open Source projects like this one. The app sends subscribers a random open issue for them to help "triage". For some languages you can also suggested areas to add documentation. The initial approach was inspired by seeing the work of the small core team spending countless hours asking "what version was this in" and "can you give us an example app". The idea is to outsource these small interactions to a huge team of volunteers and let the core team focus on their work. I want to add a badge to the README of this project. The idea is to provide an easy link for people to get started contributing to this project. A badge indicates the number of people currently subscribed to help the repo. The color is based off of open issues in the project. Here are some examples of other projects that have a badge in their README: - https://github.com/crystal-lang/crystal - https://github.com/rails/rails - https://github.com/codetriage/codetriage Thanks for building open source software, I would love to help you find some helpers.
* | Merge branch 'master' into ldap-username-fieldChristoph (Sheogorath) Kern2017-12-121-2/+2
|\ \
| * | parse HMD_LDAP_SEARCHATTRIBUTES env var as a comma-separated arrayalecdwm2017-12-091-1/+1
| | | | | | | | | | | | Signed-off-by: Alec WM <firstcontact@owls.io>
| * | Update README.mdChristoph (Sheogorath) Kern2017-12-091-1/+1
| | |
* | | Add setting `ldap.usernameField`Lukas Kalbertodt2017-12-091-0/+1
|/ / | | | | | | | | | | | | | | This determines which ldap field is used as the username on HackMD. By default, the "id" is used as username, too. The id is taken from the fields `uidNumber`, `uid` or `sAMAccountName`. To give the user more flexibility, they can now choose the field used for the username instead.
* | added guide for SAML settingsNorihito Nakae2017-12-041-2/+1
| |
* | added environment variables for SAMLNorihito Nakae2017-11-291-0/+10
| |
* | Initial support for SAML authenticationNorihito Nakae2017-11-281-1/+3
| |
* | added auth docs and images for GitHub and TwitterDevon Jue2017-11-081-1/+1
| |
* | [README] Add icons to browser version support listPeter Dave Hello2017-10-311-5/+5
| |