summaryrefslogtreecommitdiff
path: root/README.md (unfollow)
Commit message (Collapse)AuthorFilesLines
2018-02-17Rerun doctocZearin1-2/+2
Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
2018-02-17Update README.mdZearin1-117/+117
Signed-off-by: Anthony "Zearin" Rogers <zearin@users.sourceforge.net>
2018-02-08Add matrix.org badge to README.mdChristoph (Sheogorath) Kern1-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>
2018-01-31Update Heroku buttonSheogorath1-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>
2018-01-29Update badges in README.mdSheogorath1-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>
2018-01-29Add simple user-management tool for emailsignin …Dario Ernst1-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>
2018-01-27Remove camel case from `imageuploadtype` in configSheogorath1-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>
2018-01-26Add recommendation for 2GB RAMSheogorath1-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>
2018-01-26Extend README changes for minioSheogorath1-3/+3
2018-01-23Add README and `config.json.example` contentSheogorath1-1/+7
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-01-20Add option to enable `freely` permission in closed instanceDario Ernst1-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>
2018-01-18Update README.mdMax Wu1-1/+1
To show "Community Edition" on title.
2018-01-03[ci skip] Add CodeTriage badgeschneems1-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.
2017-12-09parse HMD_LDAP_SEARCHATTRIBUTES env var as a comma-separated arrayalecdwm1-1/+1
Signed-off-by: Alec WM <firstcontact@owls.io>
2017-12-09Update README.mdChristoph (Sheogorath) Kern1-1/+1
2017-12-09Add setting `ldap.usernameField`Lukas Kalbertodt1-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.
2017-12-04added guide for SAML settingsNorihito Nakae1-2/+1
2017-11-29added environment variables for SAMLNorihito Nakae1-0/+10
2017-11-28Initial support for SAML authenticationNorihito Nakae1-1/+3
2017-11-08added auth docs and images for GitHub and TwitterDevon Jue1-1/+1
2017-10-31[README] Add icons to browser version support listPeter Dave Hello1-5/+5
2017-10-31Add mattermost authenticationChristoph Witzany1-9/+13
2017-10-30Extend docker sectionSheogorath1-3/+18
2017-10-25Adds HMD_ALLOW_PDF_EXPORT to readmegeekyd1-1/+2
2017-10-22Move CSP logic to new file, Fix boolean config examplesLiterallie1-2/+2
Not sure why I was quoting these in the first place
2017-10-22Change CSP config format to be more intuitiveLiterallie1-0/+2
2017-10-17Fix a typo in README.mdFelix Yan1-1/+1
2017-10-13Integrate npm package "doctoc" to update README.mdPeter Dave Hello1-0/+4
2017-10-13Add "Table of Contents" in README.mdPeter Dave Hello1-0/+21
2017-10-13Reorganize README.md structure, cc #574Peter Dave Hello1-59/+58
2017-10-13Add env vars for extra HSTS optionsLiterallie1-0/+3
2017-10-13Add on/off env var for HSTSLiterallie1-0/+1
2017-10-13Make HSTS behaviour configurable; Fixes #584Literallie1-0/+1
2017-10-10Add version badge in README.mdPeter Dave Hello1-0/+3
2017-09-23Correct documentation of S3 bucketJohannes Weißl1-1/+2
Documentation added in aaf034b on Nov 17th 2016 says the S3 bucket can be specified with `s3.bucket`, but commit c8bcc4c (#285) on Dec 18th 2016 used `s3bucket`. Instead of fixing the code (#552) to match the documentation this commit changes just the documentation so that existing configurations are not broken. Also, the `s3` object is passed as is to `AWS.S3()`, which does not know the option `bucket` (but silently ignores it in my test). http://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property Following the old documentation leads to this exception: 2017-09-23T09:42:38.079Z - error: MissingRequiredParameter: Missing required key 'Bucket' in params at ParamValidator.fail (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/param_validator.js:50:37) at ParamValidator.validateStructure (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/param_validator.js:61:14) at ParamValidator.validateMember (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/param_validator.js:88:21) at ParamValidator.validate (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/param_validator.js:34:10) at Request.VALIDATE_PARAMETERS (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/event_listeners.js:125:42) at Request.callListeners (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/sequential_executor.js:105:20) at callNextListener (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/sequential_executor.js:95:12) at /srv/hackmd/hackmd/node_modules/aws-sdk/lib/event_listeners.js:85:9 at finish (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/config.js:315:7) at /srv/hackmd/hackmd/node_modules/aws-sdk/lib/config.js:333:9 at Credentials.get (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/credentials.js:126:7) at getAsyncCredentials (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/config.js:327:24) at Config.getCredentials (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/config.js:347:9) at Request.VALIDATE_CREDENTIALS (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/event_listeners.js:80:26) at Request.callListeners (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/sequential_executor.js:101:18) at Request.emit (/srv/hackmd/hackmd/node_modules/aws-sdk/lib/sequential_executor.js:77:10)
2017-03-25Add defaultpermission protected example valueWonder Chang1-1/+1
2017-03-14Fix badges and links in README.mdMax Wu1-1/+4
2017-03-14Add config option for gitlab api scope and auto adapt gitlab snippet feature ↵Wu Cheng-Han1-0/+1
on it
2017-03-13Add JavaScript Standard Style badge in READMEBoHong Li1-0/+2
add badge to let people know that code is using the standard style
2017-02-15Test up to 7.5.0bananaappletw1-1/+1
2017-02-15Add travis cibananaappletw1-2/+8
2017-02-10simplified descriptionNV1-2/+2
2017-02-09Update READMENV1-0/+2
2017-02-08add reference to packages, instead of writing down solutions for specific osJun SAKATA1-3/+1
2017-02-07Fix HMD_LDAP_TLS_CA not passing correctly and update README.mdWu Cheng-Han1-6/+6
2017-02-06add sudoJun SAKATA1-1/+1
2017-02-06Add additional comment about Prerequisite to READMEJun SAKATA1-0/+2
2017-01-14Update README.md for npm scriptbananaappletw1-1/+1
2017-01-14Update READMEYukai Huang1-13/+3
2017-01-13Update README.md to describe allowemailregister config more clearWu Cheng-Han1-2/+2