summaryrefslogtreecommitdiff
path: root/docs (unfollow)
Commit message (Collapse)AuthorFilesLines
2020-08-04feat: add default values to configuration documentationoupala1-147/+148
Add default values to configuration documentation when a default value is hard-coded. Specify **no default** otherwise. Signed-off-by: oupala <oupala@users.noreply.github.com>
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 Maroni14-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-11allow to set a saml client certificateSimeon Keske1-12/+13
Signed-off-by: Simeon Keske <git@n0emis.eu>
2020-07-10style: linting markdown filesoupala29-313/+314
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-07-02Create yunohost.mdericgaspar1-0/+8
Signed-off-by: ericgaspar <junk.eg@free.fr> Add setup doc about deploying CodiMD with YunoHost.
2020-06-20Backport of #278 for 1.6.1Victor Berger1-1/+2
This is a backport of #278 with the default value of `scope` changed to `undefined`. This is thus a fully backward-compatible change. Signed-off-by: Victor Berger <victor.berger@m4x.org>
2020-06-20fix: outdated internal links in documentationoupala1-7/+6
Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-19Fix docs/configuration formattingDexter Chua1-4/+4
Signed-off-by: Dexter Chua <dalcde@yahoo.com.hk>
2020-06-17refactor: move some documentationoupala1-4/+4
Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-17fix: document CMD_S3_ENDPOINT ENV variableoupala1-0/+1
fix #349 Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-17refactor: lint markdownoupala1-24/+1
Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-17doc: merge configuration-config-file.md and configuration-env-vars.md to ↵oupala3-452/+288
configuration.md Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-06-12Fix allow anonymous edit documentationDavid Sawatzke2-2/+2
The default is false and the option only matters if allowAnonymous is true Signed-off-by: David Sawatzke <d-git@sawatzke.dev>
2020-06-12Update Cloudron docsGirish Ramakrishnan1-1/+6
Added a link to the demo and source code repo Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
2020-04-25Add document explaining different URLsErik Michelson1-0/+34
Signed-off-by: Erik Michelson <erik@liltv.de>
2020-02-11Adjust description of CMD_ALLOW_ANONYMOUS_EDITSStefan Peters1-1/+1
`CMD_ALLOW_ANONYMOUS_EDITS` is only applied when `CMD_ALLOW_ANONYMOUS` is `false`, see [here](https://github.com/codimd/server/blob/9c1665ae5bf3cf38210ffd862d10de9b13bfacdd/lib/config/index.js#L71-L73). Signed-off-by: Stefan Peters <stefandesu@exo.pm>
2020-02-09Update CDN defaultsSheogorath1-1/+1
As we noticed in our poll about CDN usage, that most people intentionally turn it off, but very little intetionally turn it on or leave it on. [1] There is also strong indicators that CDNs don't really provide any benefits in loading time and due to the small deployments of CodiMD, there is no big savings due to CDNs either. [2] Therefore this patch changes the CDN default settings to off in order to reduce the exposed user data. [1]: https://community.codimd.org/t/poll-on-cdn-usage/28 [2]: https://csswizardry.com/2019/05/self-host-your-static-assets/ Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2020-02-08Add Google oauth variable: hostedDomainike2-1/+2
Which is part of `passport-google-oauth2`. It could be used as whitelist to a domain supported by google oauth. Ref: https://github.com/jaredhanson/passport-google-oauth2/issues/3 Signed-off-by: ike <developer@ikewat.com>
2020-01-16update env docs in reference to #247Amolith1-1/+1
Signed-off-by: Amolith <amolith@nixnet.xyz>
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-12-24[DOC] Run `manage_users` with `NODE_ENV=production` set.Matteo Savatteri2-2/+2
`manage_user` script defaults to `development` environment. Signed-off-by: Matteo Savatteri <matteosavatteri@lcm.mi.infn.it>
2019-12-20[DOC] Use `npm start`, not `yarn start` to startEnrico Guiraud1-2/+2
`yarn start --production` ignores the `--production` flag, `npm start --production` does not. Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
2019-12-20[DOC] Misc improvements to manual setup instructionsEnrico Guiraud1-5/+10
Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-01 17:05:56 +0000