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
Christian Bläul
c065d45da8
Documentation of config options: Improve db
...
Signed-off-by: Christian Bläul <christian@blaeul.de >
2019-08-17 00:03:04 +02:00
Salim B
5e7715a4e2
Slightly improve docker-linux-server.md
...
- fix typo
- add link to PhantomJS
- improve formatting
Signed-off-by: Salim B <salim@posteo.de >
2019-08-01 20:11:55 +02:00
Sheogorath
788d8ca933
Fix some minor quirks in the LinuxServer.io docs
...
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-08-01 20:03:07 +02:00
chbmb
04d26637d6
Add docker image from LinuxServer.io as an install option.
...
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-12 11:46:49 +01:00
Sheogorath
7cdb325e1c
Move DCO into docs section
...
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-06-10 17:35:36 +02:00
Claudius Coenen
8d576895ea
mentioning the node 6 deprecation along with the migration guide
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-05-31 15:16:24 +02:00
Sheogorath
6c62efae2a
Add config for toobusy middleware
...
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-25 21:08:38 +02:00
Claudius
806ebe6e1a
drop node 6 support
...
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-13 19:37:21 +02:00
Claudius
1d403e183d
asyncified setting and verifying the password
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-05-13 19:37:21 +02:00
Simon Fish
d1fbf63291
Improve documentation
...
Signed-off-by: Simon Fish <si@mon.fish >
2019-05-06 17:15:07 +01:00
Simon Fish
335065cba9
Provide documentation for configuration with Keycloak
...
Signed-off-by: Simon Fish <si@mon.fish >
2019-05-06 17:15:07 +01:00
Mauricio Robayo
d4ac3fdd5f
Add name of directory to clone into
...
Signed-off-by: Mauricio Robayo <rfmajo@gmail.com >
2019-05-05 19:28:30 -05:00
Claudius
32d3b914b2
fixing manual upgrade instructions and completing requirements
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-04-15 22:25:06 +02:00
Dylan Dervaux
208070d2e7
Add lutim support
...
Signed-off-by: Dylan Dervaux <dylanderv05@gmail.com >
2019-04-10 01:37:12 +02:00
Emmanuel Ormancey
df53f465c0
Added a configuration option for passport-saml:
...
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-06 17:54:58 +02:00
Claudius
a140bff47e
minor fixes to internal links in documentation
2019-04-01 09:42:33 +02:00
Claudius
33b22cf26f
breaking up config docs into sections
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-04-01 01:16:24 +02:00
Claudius
54edec8900
striving for consistency across various docs
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-04-01 01:03:36 +02:00
Claudius
74fdd26ea0
integrating information from the old wiki
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-04-01 01:03:36 +02:00
Claudius
edf301cfa3
splitting README.md into files in /docs for better readability
...
Signed-off-by: Claudius <opensource@amenthes.de >
2019-04-01 01:03:36 +02:00
Sheogorath
982a12f569
Fix some remaining references to the old repository
...
Signed-off-by: Sheogorath <sheogorath@shivering-isles.com >
2019-03-28 22:45:57 +01:00