summaryrefslogtreecommitdiff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Fixed JSON syntax error in api doc exampleErik Michelson2019-10-181-1/+1
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Finishing openapi docErik Michelson2019-10-171-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>
* WIP: Adding openapi docErik Michelson2019-10-152-1/+195
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Added API-doc as markdown fileErik Michelson2019-10-131-0/+43
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Added link to libravatar.orgErik Michelson2019-09-092-2/+2
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Extended login methods sectionErik Michelson2019-09-091-2/+43
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Changed Gravatar to LibravatarErik Michelson2019-09-092-2/+2
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Merge pull request #143 from Fonata/improve-docsSheogorath2019-09-022-27/+27
|\ | | | | Slightly improve documentation
| * Documentation: improved 'Users and Privileges' sectionChristian Bläul2019-08-172-5/+5
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: improved EnglishChristian Bläul2019-08-171-2/+2
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Not serverurl, but serverURL is used as a default for issuerChristian Bläul2019-08-171-1/+1
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: improved sessionLife descriptionChristian Bläul2019-08-172-2/+2
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: improved 'Email (local account)' sectionsChristian Bläul2019-08-172-4/+4
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: improved dbURL descriptionChristian Bläul2019-08-172-2/+2
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: Improved descriptions of 'Users and Privileges' sectionChristian Bläul2019-08-171-3/+3
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation: converted descriptions to sentences to allow more detailsChristian Bläul2019-08-171-7/+7
| | | | | | | | | | | | No content was added; this is just a formatting commit. Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Config documentation: Improved spelling and capitalization of servicesChristian Bläul2019-08-171-6/+6
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation of config options: Improve loglevelChristian Bläul2019-08-171-1/+1
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
| * Documentation of config options: Improve dbChristian Bläul2019-08-171-1/+1
| | | | | | | | Signed-off-by: Christian Bläul <christian@blaeul.de>
* | Remove useless blank lineMatthias Lindinger2019-09-021-1/+0
| | | | | | | | Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
* | Add documentation for the new imprint featureMatthias Lindinger2019-09-021-0/+10
|/ | | | Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
* Slightly improve docker-linux-server.mdSalim B2019-08-011-4/+4
| | | | | | | | - fix typo - add link to PhantomJS - improve formatting Signed-off-by: Salim B <salim@posteo.de>
* Fix some minor quirks in the LinuxServer.io docsSheogorath2019-08-011-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>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-09 22:37:11 +0000