summaryrefslogtreecommitdiff
path: root/docs/guides (unfollow)
Commit message (Collapse)AuthorFilesLines
2021-01-05Move docs into subdirectory to make mkdocs work in a subdirectoryTilman Vatteroth16-958/+0
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-03added all necessary configs to use structorPhilip Molares1-3/+0
see https://github.com/traefik/structor Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03started work on a mkdocs documentation for readthedocs.orgPhilip Molares1-0/+3
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2020-11-15Update docs/guides/auth/keycloak.mdmrdrogdrog1-1/+1
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15Update docs/guides/migrations-and-breaking-changes.mdmrdrogdrog1-1/+1
Co-authored-by: Philip Molares <git@molar.es>
2020-11-14Correct repo nameTilman Vatteroth3-4/+4
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14Replace CodiMD with HedgeDocErik Michelson15-90/+88
Signed-off-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in public/views Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in README Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in SECURITY.md Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in LICENSE Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in docs/configuration.md Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in bin/setup Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/guides Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/dev Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/guides/auth Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/setup Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update various links in code to the new GitHub org. Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js Signed-off-by: David Mehren <git@herrmehren.de> Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: References in docs/setup/yunohost Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rebrand to HedgeDoc: Add banner and logo Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Remove note in docs/guides/auth/github Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace links in public/docs/features Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add todo placeholder in docs/history Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace github link in public/views/index/body Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Replace github link in README Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add logo to README Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Rename to HedgeDoc: Add note about the renaming to the front page Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> Removed Travis from README.md and change CodiMD to HedgeDoc in some places Signed-off-by: Yannick Bungers <git@innay.de> Some more renaming to HedgeDoc - Fixed capitalization of HedgeDoc - Added renaming for etherpad migration doc Signed-off-by: Yannick Bungers <git@innay.de> Changed Repo name to hedgedoc Signed-off-by: Yannick Bungers <git@innay.de>
2020-11-12Adds convenience script to migrate to minio.pierreozoux1-0/+10
Signed-off-by: pierreozoux <pierre@ozoux.net>
2020-07-11Fixed Image Sources in saml-keycloak guideLeo Maroni1-11/+11
Signed-off-by: Leo Maroni <git@em0lar.de>
2020-07-11Create Keycloak SAML guideLeo Maroni2-1/+114
Co-authored-by: Simeon Keske <git@n0emis.eu> Signed-off-by: Simeon Keske <git@n0emis.eu> Signed-off-by: Leo Maroni <git@em0lar.de>
2020-07-10style: linting markdown filesoupala15-210/+216
Linting markdown files according to default remark-lint configuration. Files inside the `public` directory were not linted. Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-01-13Update example config for gitlab authorizationIan Tsai1-6/+6
Update example config for gitlab authorization Signed-off-by: Ian Tsai <b10102016@gmail.com>
2019-09-02Remove useless blank lineMatthias Lindinger1-1/+0
Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
2019-09-02Add documentation for the new imprint featureMatthias Lindinger1-0/+10
Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
2019-05-31mentioning the node 6 deprecation along with the migration guideClaudius Coenen1-0/+4
Signed-off-by: Claudius <opensource@amenthes.de>
2019-05-06Improve documentationSimon Fish1-16/+27
Signed-off-by: Simon Fish <si@mon.fish>
2019-05-06Provide documentation for configuration with KeycloakSimon Fish1-0/+39
Signed-off-by: Simon Fish <si@mon.fish>
2019-04-01striving for consistency across various docsClaudius11-145/+122
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-01splitting README.md into files in /docs for better readabilityClaudius44-34/+104
Signed-off-by: Claudius <opensource@amenthes.de>
2019-03-28Fix some remaining references to the old repositorySheogorath1-1/+1
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-03-27Update links to new repositoriesSheogorath1-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>
2019-02-15Fix several typos in auth/saml.mdFelix Yan1-3/+3
Signed-off-by: Felix Yan <felixonmars@archlinux.org>
2018-11-10Add an etherpad migration guideDaan Sprenkels1-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>
2018-10-04How to use Nextcloud as OAuth2 Provider for CodiMDClaudius Coenen4-0/+52
Signed-off-by: Claudius Coenen <opensource@amenthes.de>
2018-09-30fix image paths in moved GitLab auth guidemcnesium1-3/+3
Signed-off-by: mcnesium <git@mcnesium.com>
2018-09-26Add documentation for an LDAP setup against Active DirectorySheogorath1-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>
2018-08-28Add an auth provider guide for MattermostOndřej Slabý5-0/+58
Signed-off-by: Ondřej Slabý <kron258@gmail.com>
2018-06-27Add docs for usage of terms and privacy policySheogorath1-0/+17
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2018-06-24Add note about renaming to docsSheogorath7-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>
2018-06-01Split authentication guides into multiple documentsSheogorath6-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>
2018-03-27Add documentation for setting up authentication with a self-hosted GitLabmcnesium4-0/+29
Signed-off-by: mcnesium <git@mcnesium.com>
2018-03-05Fix small typoRobin Naundorf1-1/+1
Signed-off-by: Robin Naundorf <r.naundorf@fh-muenster.de>
2018-01-27Remove camel case from `imageuploadtype` in configSheogorath2-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>
2018-01-23Add minio guideSheogorath6-0/+83
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2017-12-04added guide for SAML settingsNorihito Nakae7-0/+135
2017-11-08added auth docs and images for GitHub and TwitterDevon Jue8-0/+77
2017-09-23Correct documentation of S3 bucketJohannes Weißl1-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)
2016-11-17Update READMEYukai Huang1-0/+19
2016-11-16Fix order listYukai Huang1-29/+29
2016-11-16Create s3 config guideYukai Huang7-0/+62
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-23 10:06:25 +0000