github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 09:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
2503 commits 39 branches 47 tags 112 MiB
Commit graph

93 commits

Author SHA1 Message Date
Yannick Bungers
4c410ee416 Fixed inconsistencies in documentation 
- Updated Node.js requirement
- Added warning for older Mysql and MariaDB versions
- changed npm commands to yarn commands
- changed occurrences of CodiMD to HedgeDoc for easier merging

Signed-off-by: Yannick Bungers <git@innay.de>
 2020-11-12 19:54:32 +01:00
oupala
260e9b8958 feat: add default values to configuration documentation 
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-08-04 19:03:42 +02:00
Leo Maroni
35ec617007
Fixed Image Sources in saml-keycloak guide 
Signed-off-by: Leo Maroni <git@em0lar.de>
 2020-07-11 21:20:59 +02:00
Leo Maroni
ae8bb96cc6
Create Keycloak SAML guide 
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-11 21:20:53 +02:00
Simeon Keske
17f0067ab2
allow to set a saml client certificate 
Signed-off-by: Simeon Keske <git@n0emis.eu>
 2020-07-11 21:19:49 +02:00
David Mehren
3db8b0df43
Merge pull request #410 from oupala/feature/markdown-linting 2020-07-10 19:59:32 +02:00
oupala
2f462f90d4 style: linting markdown files 
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-10 18:57:59 +02:00
ericgaspar
91582ea722
Create yunohost.md 
Signed-off-by: ericgaspar <junk.eg@free.fr>

Add setup doc about deploying CodiMD with YunoHost.
 2020-07-02 21:31:47 +02:00
Victor Berger
5f3a1b6266 Backport of #278 for 1.6.1 
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-20 16:48:25 +02:00
Sheogorath
0ef5261e61
Merge pull request #398 from gramakri/patch-1 
Update Cloudron docs
 2020-06-20 14:58:05 +02:00
oupala
1ea99b0ec2 fix: outdated internal links in documentation 
Signed-off-by: oupala <oupala@users.noreply.github.com>
 2020-06-20 11:44:29 +02:00
Dexter Chua
aba68eb39a Fix docs/configuration formatting 
Signed-off-by: Dexter Chua <dalcde@yahoo.com.hk>
 2020-06-19 06:23:23 +08:00
oupala
46e86b1be3 refactor: move some documentation 
Signed-off-by: oupala <oupala@users.noreply.github.com>
 2020-06-17 15:33:55 +02:00
oupala
712e2194f4 fix: document CMD_S3_ENDPOINT ENV variable 
fix #349

Signed-off-by: oupala <oupala@users.noreply.github.com>
 2020-06-17 10:54:12 +02:00
oupala
65fc44e32f refactor: lint markdown 
Signed-off-by: oupala <oupala@users.noreply.github.com>
 2020-06-17 10:54:12 +02:00
oupala
e46d520ca2 doc: merge configuration-config-file.md and configuration-env-vars.md to configuration.md 
Signed-off-by: oupala <oupala@users.noreply.github.com>
 2020-06-17 10:54:12 +02:00
David Sawatzke
c5ff30c5a1 Fix allow anonymous edit documentation 
The default is false and the option only matters if allowAnonymous is true

Signed-off-by: David Sawatzke <d-git@sawatzke.dev>
 2020-06-12 22:17:43 +02:00
Girish Ramakrishnan
8319c19aa5 Update Cloudron docs 
Added a link to the demo and source code repo

Signed-off-by: Girish Ramakrishnan <girish@cloudron.io>
 2020-06-12 11:23:10 -07:00
Erik Michelson
2e7488870e
Add document explaining different URLs 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2020-04-25 01:27:07 +02:00
Stefan Peters
5ee3213086
Adjust description of CMD_ALLOW_ANONYMOUS_EDITS 
`CMD_ALLOW_ANONYMOUS_EDITS` is only applied when `CMD_ALLOW_ANONYMOUS` is `false`, see [here](9c1665ae5b/lib/config/index.js (L71-L73)).

Signed-off-by: Stefan Peters <stefandesu@exo.pm>
 2020-02-11 13:32:22 +09:00
Sheogorath
651db60985
Update CDN defaults 
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-09 21:59:17 +01:00
ike
197223dc81 Add Google oauth variable: hostedDomain 
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-02-08 15:57:22 +08:00
Amolith
412540b8e5 update env docs in reference to #247 
Signed-off-by: Amolith <amolith@nixnet.xyz>
 2020-01-16 17:25:41 -05:00
Ian Tsai
deb3b94662 Update example config for gitlab authorization 
Update example config for gitlab authorization

Signed-off-by: Ian Tsai <b10102016@gmail.com>
 2020-01-13 19:30:15 +08:00
Matteo Savatteri
8496baa5b9 [DOC] Run manage_users with NODE_ENV=production set. 
`manage_user` script defaults to `development` environment.

Signed-off-by: Matteo Savatteri <matteosavatteri@lcm.mi.infn.it>
 2019-12-24 18:02:55 +01:00
Enrico Guiraud
ed2a792886
[DOC] Use npm start, not yarn start to start 
`yarn start --production` ignores the `--production` flag,
`npm start --production` does not.

Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
 2019-12-20 11:08:40 +01:00
Enrico Guiraud
5c552b81a0
[DOC] Misc improvements to manual setup instructions 
Signed-off-by: Enrico Guiraud <enrico.guiraud@cern.ch>
 2019-12-20 00:26:48 +01:00
Sheogorath
31803d6730
Merge pull request #209 from davidmehren/webpack_docs 
Improve webpack dev documentation
 2019-10-29 14:18:14 +01:00
David Mehren
b714baa36e
Improve webpack dev documentation 
Signed-off-by: David Mehren <dmehren1@gmail.com>
 2019-10-25 20:52:15 +02:00
Jonas Zohren
625f4e336b Replaces npm with yarn commands in docs. 
Signed-off-by: Jonas Zohren <jonas.zohren@tu-dortmund.de>
 2019-10-25 19:51:13 +02:00
Erik Michelson
ae4d5c619a
Fixed JSON syntax error in api doc example 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-10-18 10:59:39 +02:00
Erik Michelson
b7c02a901f
Finishing openapi doc 
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-17 23:26:48 +02:00
Erik Michelson
93ca037a75
WIP: Adding openapi doc 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-10-15 00:58:40 +02:00
Erik Michelson
447d9bc1d8
Added API-doc as markdown file 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-10-13 01:34:09 +02:00
Erik Michelson
6110aafc5b
Added link to libravatar.org 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-09-09 15:20:09 +02:00
Erik Michelson
efe246f183
Extended login methods section 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-09-09 01:48:22 +02:00
Erik Michelson
5a359ab648
Changed Gravatar to Libravatar 
Signed-off-by: Erik Michelson <erik@liltv.de>
 2019-09-09 00:47:22 +02:00
Sheogorath
c765f34d03
Merge pull request #143 from Fonata/improve-docs 
Slightly improve documentation
 2019-09-02 19:24:04 +03:00
Matthias Lindinger
e07f70c231 Remove useless blank line 
Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
 2019-09-02 13:09:23 +02:00
Matthias Lindinger
eef2b57bde Add documentation for the new imprint feature 
Signed-off-by: Matthias Lindinger <m.lindinger@live.de>
 2019-09-02 13:05:17 +02:00
Christian Bläul
d21ede4df8 Documentation: improved 'Users and Privileges' section 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 12:19:34 +02:00
Christian Bläul
3684c65f10 Documentation: improved English 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 12:14:51 +02:00
Christian Bläul
49663390d1 Not serverurl, but serverURL is used as a default for issuer 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 12:14:24 +02:00
Christian Bläul
ef857a565c Documentation: improved sessionLife description 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 11:56:31 +02:00
Christian Bläul
32f00e9830 Documentation: improved 'Email (local account)' sections 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 11:53:49 +02:00
Christian Bläul
29e1ff7699 Documentation: improved dbURL description 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 11:40:53 +02:00
Christian Bläul
60d6a6a15d Documentation: Improved descriptions of 'Users and Privileges' section 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 10:53:17 +02:00
Christian Bläul
374ee58790 Documentation: converted descriptions to sentences to allow more details 
No content was added; this is just a formatting commit.

Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 10:49:03 +02:00
Christian Bläul
305525aa0c Config documentation: Improved spelling and capitalization of services 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 00:03:37 +02:00
Christian Bläul
f49bbf4c45 Documentation of config options: Improve loglevel 
Signed-off-by: Christian Bläul <christian@blaeul.de>
 2019-08-17 00:03:29 +02:00