summaryrefslogtreecommitdiff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Add docker image from LinuxServer.io as an install option.chbmb2019-06-122-1/+15
| | | | | As requested by @SISheogorath [here](https://github.com/linuxserver/docker-codimd/issues/4#issue-454332233) and further to discussion about previous PR [here.](https://github.com/codimd/server/pull/110#issuecomment-501214087) Signed-off-by: Neil Green <chbmb@linuxserver.io>
* Move DCO into docs sectionSheogorath2019-06-101-0/+35
| | | | | | | | | | | | | | The DCO currently resides in an own directory creating a pointless additional click/tab in order to reach end read it. It also just clutteres the directory structure of the project. Therefore this patch provides moves the DCO into an own legal section in the docs directory, which is hopefully a more reasonable place. This section can also be extended in future in order to host other legal documents as well. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* mentioning the node 6 deprecation along with the migration guideClaudius Coenen2019-05-311-0/+4
| | | Signed-off-by: Claudius <opensource@amenthes.de>
* Add config for toobusy middlewareSheogorath2019-05-252-0/+2
| | | | | | | | | | With very low CPU frequency or bad IO situation, as well as not-loaded JS CodiMD happens to present unneeded "I'm busy"-messages to users. This patch allows to configure the lag. The default is taken from the libray but set in our own default configs. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* drop node 6 supportClaudius2019-05-131-1/+1
| | | | | | | | We will no longer test on node6 and instead focus on 8+. This won't break node6 immediately, but we will no longer go out of our way supporting a version that does not receive security updates. Signed-off-by: Claudius <opensource@amenthes.de>
* asyncified setting and verifying the passwordClaudius2019-05-131-1/+0
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* Improve documentationSimon Fish2019-05-061-16/+27
| | | | Signed-off-by: Simon Fish <si@mon.fish>
* Provide documentation for configuration with KeycloakSimon Fish2019-05-061-0/+39
| | | | Signed-off-by: Simon Fish <si@mon.fish>
* Add name of directory to clone intoMauricio Robayo2019-05-051-1/+1
| | | | Signed-off-by: Mauricio Robayo <rfmajo@gmail.com>
* fixing manual upgrade instructions and completing requirementsClaudius2019-04-151-18/+19
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* Add lutim supportDylan Dervaux2019-04-102-3/+15
| | | | Signed-off-by: Dylan Dervaux <dylanderv05@gmail.com>
* Added a configuration option for passport-saml:Emmanuel Ormancey2019-04-061-0/+1
| | | | | | | | | | | disableRequestedAuthnContext: true|false By default only Password authmethod is accepted, this option allows any other method. Issue and option described here: https://github.com/bergie/passport-saml/issues/226 Signed-off-by: Emmanuel Ormancey <emmanuel.ormancey@cern.ch>
* minor fixes to internal links in documentationClaudius2019-04-012-12/+12
|
* breaking up config docs into sectionsClaudius2019-04-012-76/+292
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* striving for consistency across various docsClaudius2019-04-0123-165/+168
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* integrating information from the old wikiClaudius2019-04-012-4/+204
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* splitting README.md into files in /docs for better readabilityClaudius2019-04-0155-34/+417
| | | | Signed-off-by: Claudius <opensource@amenthes.de>
* Fix some remaining references to the old repositorySheogorath2019-03-281-1/+1
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Update links to new repositoriesSheogorath2019-03-271-5/+5
| | | | | | | | | | | | After a long discussion, it turned out that CodiMD as community project and HackMD as a company, have fundamental different views on the project governance. 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 <sheogorath@shivering-isles.com>
* Fix several typos in auth/saml.mdFelix Yan2019-02-151-3/+3
| | | | Signed-off-by: Felix Yan <felixonmars@archlinux.org>
* Add an etherpad migration guideDaan Sprenkels2018-11-101-0/+131
| | | | | | | | | In this guide I share how a migration from etherpad to codimd can be done. I am not completely sure if the script that is included is completely error-free. Readers/reviewers should be aware that there may be bugs.may be bugs. Signed-off-by: Daan Sprenkels <hello@dsprenkels.com>
* Add dev-docs for webpack.David Mehren2018-10-101-0/+26
| | | | Signed-off-by: David Mehren <dmehren1@gmail.com>
* How to use Nextcloud as OAuth2 Provider for CodiMDClaudius Coenen2018-10-044-0/+52
| | | | Signed-off-by: Claudius Coenen <opensource@amenthes.de>
* Merge pull request #974 from mcnesium/patch-1Christoph (Sheogorath) Kern2018-10-031-3/+3
|\ | | | | fix image paths
| * fix image paths in moved GitLab auth guidemcnesium2018-09-301-3/+3
| | | | | | | | Signed-off-by: mcnesium <git@mcnesium.com>
* | Add documentation for an LDAP setup against Active DirectorySheogorath2018-09-261-0/+42
|/ | | | | | | Since our documentation on our LDAP configs is quite small, I add this example for LDAP in an Active Directory environment. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add an auth provider guide for MattermostOndřej Slabý2018-08-285-0/+58
| | | | Signed-off-by: Ondřej Slabý <kron258@gmail.com>
* Add docs for usage of terms and privacy policySheogorath2018-06-271-0/+17
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add note about renaming to docsSheogorath2018-06-247-2/+16
| | | | | | | | It's way easier to add a note to the guides than to redo all the images, etc. We have more important things to spend our time on, but if someone wants to redo them, you are very welcome! Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Split authentication guides into multiple documentsSheogorath2018-06-016-241/+243
| | | | | | | | Splitting the documentation should provide an easier access to the documentation people searching for and result in less merge conflicts when adding new documentation here. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* Add documentation for setting up authentication with a self-hosted GitLabmcnesium2018-03-274-0/+29
| | | | Signed-off-by: mcnesium <git@mcnesium.com>
* Fix small typoRobin Naundorf2018-03-051-1/+1
| | | | Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
* Remove camel case from `imageuploadtype` in configSheogorath2018-01-272-3/+3
| | | | | | | | | | | | | 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 minio guideSheogorath2018-01-236-0/+83
| | | | Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
* added guide for SAML settingsNorihito Nakae2017-12-047-0/+135
|
* added auth docs and images for GitHub and TwitterDevon Jue2017-11-088-0/+77
|
* Correct documentation of S3 bucketJohannes Weißl2017-09-231-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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)
* Update READMEYukai Huang2016-11-171-0/+19
|
* Fix order listYukai Huang2016-11-161-29/+29
|
* Create s3 config guideYukai Huang2016-11-167-0/+62
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-05 14:56:56 +0000