summaryrefslogtreecommitdiff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* style: linting markdown filesoupala2020-07-1029-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>
* Backport of #278 for 1.6.1Victor Berger2020-06-201-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>
* Merge pull request #398 from gramakri/patch-1Sheogorath2020-06-201-1/+6
|\ | | | | Update Cloudron docs
| * Update Cloudron docsGirish Ramakrishnan2020-06-121-1/+6
| | | | | | | | | | | | Added a link to the demo and source code repo Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
* | fix: outdated internal links in documentationoupala2020-06-201-7/+6
| | | | | | | | Signed-off-by: oupala <oupala@users.noreply.github.com>
* | Fix docs/configuration formattingDexter Chua2020-06-191-4/+4
| | | | | | | | Signed-off-by: Dexter Chua <dalcde@yahoo.com.hk>
* | refactor: move some documentationoupala2020-06-171-4/+4
| | | | | | | | Signed-off-by: oupala <oupala@users.noreply.github.com>
* | fix: document CMD_S3_ENDPOINT ENV variableoupala2020-06-171-0/+1
| | | | | | | | | | | | fix #349 Signed-off-by: oupala <oupala@users.noreply.github.com>
* | refactor: lint markdownoupala2020-06-171-24/+1
| | | | | | | | Signed-off-by: oupala <oupala@users.noreply.github.com>
* | doc: merge configuration-config-file.md and configuration-env-vars.md to ↵oupala2020-06-173-452/+288
| | | | | | | | | | | | configuration.md Signed-off-by: oupala <oupala@users.noreply.github.com>
* | Fix allow anonymous edit documentationDavid Sawatzke2020-06-122-2/+2
|/ | | | | | The default is false and the option only matters if allowAnonymous is true Signed-off-by: David Sawatzke <d-git@sawatzke.dev>
* Add document explaining different URLsErik Michelson2020-04-251-0/+34
| | | | Signed-off-by: Erik Michelson <erik@liltv.de>
* Adjust description of CMD_ALLOW_ANONYMOUS_EDITSStefan Peters2020-02-111-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>
* Update CDN defaultsSheogorath2020-02-091-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>
* Add Google oauth variable: hostedDomainike2020-02-082-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>
* update env docs in reference to #247Amolith2020-01-161-1/+1
| | | | Signed-off-by: Amolith <amolith@nixnet.xyz>
* Update example config for gitlab authorizationIan Tsai2020-01-131-6/+6
| | | | | | Update example config for gitlab authorization Signed-off-by: Ian Tsai <b10102016@gmail.com>
* [DOC] Run `manage_users` with `NODE_ENV=production` set.Matteo Savatteri2019-12-242-2/+2
| | | | | | `manage_user` script defaults to `development` environment. Signed-off-by: Matteo Savatteri <matteosavatteri@lcm.mi.infn.it>
* [DOC] Use `npm start`, not `yarn start` to startEnrico Guiraud2019-12-201-2/+2
| | | | | | | `yarn start --production` ignores the `--production` flag, `npm start --production` does not. Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
* [DOC] Misc improvements to manual setup instructionsEnrico Guiraud2019-12-201-5/+10
| | | | Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
* Merge pull request #209 from davidmehren/webpack_docsSheogorath2019-10-291-1/+8
|\ | | | | Improve webpack dev documentation
| * Improve webpack dev documentationDavid Mehren2019-10-251-1/+8
| | | | | | | | Signed-off-by: David Mehren <dmehren1@gmail.com>
* | Replaces `npm` with `yarn` commands in docs.Jonas Zohren2019-10-252-6/+6
|/ | | | Signed-off-by: Jonas Zohren <jonas.zohren@tu-dortmund.de>
* 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-23 20:06:17 +0000