summaryrefslogtreecommitdiff
path: root/docs (unfollow)
Commit message (Collapse)AuthorFilesLines
2019-10-25Improve webpack dev documentationDavid Mehren1-1/+8
Signed-off-by: David Mehren <dmehren1@gmail.com>
2019-10-25Replaces `npm` with `yarn` commands in docs.Jonas Zohren2-6/+6
Signed-off-by: Jonas Zohren <jonas.zohren@tu-dortmund.de>
2019-10-18Fixed JSON syntax error in api doc exampleErik Michelson1-1/+1
Signed-off-by: Erik Michelson <erik@liltv.de>
2019-10-17Finishing openapi docErik Michelson1-1/+288
version 1.6.0 is noted as this document already contains the 1.6.0 endpoint /new/alias Signed-off-by: Erik Michelson <erik@liltv.de>
2019-10-15WIP: Adding openapi docErik Michelson2-1/+195
Signed-off-by: Erik Michelson <erik@liltv.de>
2019-10-13Added API-doc as markdown fileErik Michelson1-0/+43
Signed-off-by: Erik Michelson <erik@liltv.de>
2019-09-09Added link to libravatar.orgErik Michelson2-2/+2
Signed-off-by: Erik Michelson <erik@liltv.de>
2019-09-09Extended login methods sectionErik Michelson1-2/+43
Signed-off-by: Erik Michelson <erik@liltv.de>
2019-09-09Changed Gravatar to LibravatarErik Michelson2-2/+2
Signed-off-by: Erik Michelson <erik@liltv.de>
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-08-17Documentation: improved 'Users and Privileges' sectionChristian Bläul2-5/+5
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: improved EnglishChristian Bläul1-2/+2
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Not serverurl, but serverURL is used as a default for issuerChristian Bläul1-1/+1
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: improved sessionLife descriptionChristian Bläul2-2/+2
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: improved 'Email (local account)' sectionsChristian Bläul2-4/+4
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: improved dbURL descriptionChristian Bläul2-2/+2
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: Improved descriptions of 'Users and Privileges' sectionChristian Bläul1-3/+3
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation: converted descriptions to sentences to allow more detailsChristian Bläul1-7/+7
No content was added; this is just a formatting commit. Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Config documentation: Improved spelling and capitalization of servicesChristian Bläul1-6/+6
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation of config options: Improve loglevelChristian Bläul1-1/+1
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-17Documentation of config options: Improve dbChristian Bläul1-1/+1
Signed-off-by: Christian Bläul <christian@blaeul.de>
2019-08-01Slightly improve docker-linux-server.mdSalim B1-4/+4
- fix typo - add link to PhantomJS - improve formatting Signed-off-by: Salim B <salim@posteo.de>
2019-08-01Fix some minor quirks in the LinuxServer.io docsSheogorath1-6/+6
The current documents might end up confusing people and are not completely accessible. This minor fixes should clear up the situation and add alt texts to all badges, explain the links at the end of the docs, and list LinuxServer.io in the supported provider section of the README. Some reasoning on the change in the listing: Since we maintain an own container image which is for sure kept updated on release, this is our first listing, as well as general solutions that are build on that image, like the K8s integration. The next listings are integrated provides which allow self-hosting, like Cloudron and I also consider LinuxServer.io as this kind of providers. Which try to enable people to run CodiMD on their own hardware or rented servers in a very easy way, but by using their own images. As third category I would look at hosted offers, like Heroku, which are not completely SaaS but far enough away from the self-hostability that I consider them as an own category. PaaS-based solutions are not as FOSS-style as we want our setups to be, but of course still supported. Finally the manual setup. We keep it down here, because we support it, but don't recommend it in general. It's hard to upgrade and can cause problems when dependencies are not correctly updated or people don't run the db migrations. Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2019-06-12Add docker image from LinuxServer.io as an install option.chbmb2-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>
2019-06-10Move DCO into docs sectionSheogorath1-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>
2019-05-31mentioning the node 6 deprecation along with the migration guideClaudius Coenen1-0/+4
Signed-off-by: Claudius <opensource@amenthes.de>
2019-05-25Add config for toobusy middlewareSheogorath2-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>
2019-05-13drop node 6 supportClaudius1-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>
2019-05-13asyncified setting and verifying the passwordClaudius1-1/+0
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-05-05Add name of directory to clone intoMauricio Robayo1-1/+1
Signed-off-by: Mauricio Robayo <rfmajo@gmail.com>
2019-04-15fixing manual upgrade instructions and completing requirementsClaudius1-18/+19
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-10Add lutim supportDylan Dervaux2-3/+15
Signed-off-by: Dylan Dervaux <dylanderv05@gmail.com>
2019-04-06Added a configuration option for passport-saml:Emmanuel Ormancey1-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>
2019-04-01minor fixes to internal links in documentationClaudius2-12/+12
2019-04-01breaking up config docs into sectionsClaudius2-76/+292
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-01striving for consistency across various docsClaudius23-165/+168
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-01integrating information from the old wikiClaudius2-4/+204
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-01splitting README.md into files in /docs for better readabilityClaudius55-34/+417
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-10Add dev-docs for webpack.David Mehren1-0/+26
Signed-off-by: David Mehren <dmehren1@gmail.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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-01 14:04:02 +0000