github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00
Code Issues Projects Releases Packages Wiki Activity
4270 commits 39 branches 47 tags 112 MiB
Commit graph

470 commits

Author SHA1 Message Date
renovate[bot]
c8907d09d9
chore(deps): update dependency mkdocs-material to v7.3.3 (#1726) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-11 16:22:17 +00:00
renovate[bot]
cfca497dec
chore(deps): update dependency mkdocs-material to v7.3.2 (#1713) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-06 21:05:06 +00:00
David Mehren
30c88d16b1
Merge pull request #1700 from ProttoyChakraborty/master 2021-10-06 18:53:08 +02:00
renovate[bot]
32f7813a84
chore(deps): update dependency mkdocs-material to v7.3.1 (#1702) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-10-02 13:30:39 +00:00
ProttoyChakraborty
96518a96a3 Updated configuration.md 
Signed-off-by: ProttoyChakraborty <pchakraborty2002@gmail.com>
 2021-10-01 19:17:04 +05:30
Renovate Bot
c63320a578
chore(deps): update dependency mkdocs-material to v7.3.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-09-23 09:07:24 +00:00
renovate[bot]
adfe820c98
chore(deps): update dependency mkdocs-material to v7.2.8 (#1656) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-20 13:00:46 +00:00
renovate[bot]
2def3ca721
chore(deps): update dependency mkdocs-material to v7.2.7 (#1652) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-19 16:22:14 +00:00
David Mehren
c3deb715dd
Bump version to 1.9.0 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-09-13 21:57:57 +02:00
Yannick Bungers
0a29738e62
Merge pull request #1610 from hedgedoc/fix-hfm-header 
Fix usage of "HFM" in table headers
 2021-09-03 12:34:46 +02:00
Tilman Vatteroth
4f76585664
Fix usage of "HFM" in table headers 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-09-02 22:00:16 +02:00
renovate[bot]
04c4dd888f
chore(deps): update dependency mkdocs-material to v7.2.6 (#1605) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-09-01 22:16:08 +00:00
David Mehren
ca71473ed9
Bump version to 1.9.0-rc1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-29 17:55:19 +02:00
Yannick Bungers
74b10d4e9b
Merge pull request #1571 from hedgedoc/chore/remove_tedious 
Drop support for MS SQL Server
 2021-08-26 19:59:56 +02:00
renovate[bot]
2fb83e5a34
chore(deps): update dependency mkdocs-material to v7.2.5 (#1576) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-25 08:54:44 +00:00
David Mehren
7729cc49a7
Drop support for MS SQL Server 
Sequelize generates invalid SQL for the 'fix-enum' migration from 2018.
Since nobody has complained about this issue since then, we can just
drop support for SQL Server.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-23 17:45:45 +02:00
David Mehren
e0b5c63f93
Merge pull request #1532 from hedgedoc/docs/faq 2021-08-19 21:31:10 +02:00
David Mehren
c7d581953c
Add heading to FAQ 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-19 20:22:17 +02:00
David Mehren
957d7d553e
Merge pull request #1394 from hedgedoc/remove-cdn 2021-08-15 20:11:26 +02:00
David Mehren
31bfd6d779
Clarify csp.allowFraming docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-15 00:22:31 +02:00
David Mehren
2ac89d3334
Use consistent wording in CSP docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-15 00:22:31 +02:00
David Mehren
6c722f0ad6
Add config option to disallow embedding PDFs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-15 00:22:31 +02:00
David Mehren
bd44cbc16c
Add config option to disallow framing via CSP 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-15 00:22:30 +02:00
Tilman Vatteroth
9498ee6bfe
Remove cdn support 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-08-15 00:09:53 +02:00
David Mehren
daf7d61ea2
Link to config docs in embedding FAQ 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
c1976425da
Use consistent spelling in FAQs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
ccced2d92c
Change homepage link to new FAQs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
eb270fdb6b
Add FAQ entry about broken migrations 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
6d0187bead
Add FAQ entry about broken image upload 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
c9388add9d
Add FAQ entry about iframing HedgeDoc 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
038c1b4868
Port over the FAQ page from hedgedoc.org 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 23:48:17 +02:00
David Mehren
cc76201cfb
Merge pull request #1533 from hedgedoc/feature/database-env 
feat(config): Improve configurability of database by env
 2021-08-14 23:41:58 +02:00
David Mehren
9650950d00
Docs: Use Postgres 13 in Docker example 
After https://github.com/hedgedoc/container/pull/181 has been merged,
we should now also use PG 13 in the example snippet.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-08-14 17:15:40 +02:00
Philip Molares
e158839f46 docs: fix typos 
Fixed some typos geeked pointed out on the forum

See https://community.hedgedoc.org/t/couple-spelling-errors-on-your-docs-home-page/453

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-08-14 00:28:09 +02:00
Sheogorath
1428a8e006
feat(config): Improve configurability of database by env 
This patch implements 6 additional environment variables that are used
for configuration of the database in order to allow easier configuration
in containerised environments, such as Kubernetes.

An example is the upcoming deployment of the demo instance that will use
an operator-backed postgresql database. This operator exposes username
and password as separate variables and while it's obviously possible to
generate a dbURL from that, this won't be possible without additional
code. Aiming for a solution in Hedgedoc itself, will help us to enable
other people in using Hedgedoc on Kubernetes without resulting in overly
customised setups for simple tasks like this.

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
 2021-08-13 01:58:53 +02:00
renovate[bot]
6c17823da1
chore(deps): update dependency mkdocs-material to v7.2.4 (#1528) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-11 22:19:17 +00:00
renovate[bot]
d0244affdf
chore(deps): update dependency mkdocs-material to v7.2.3 (#1524) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-09 20:53:48 +00:00
renovate[bot]
4ca2600a27
chore(deps): update dependency mkdocs-material to v7.2.2 (#1489) 
Signed-off-by: Renovate Bot <bot@renovateapp.com>

Co-authored-by: Renovate Bot <bot@renovateapp.com>
 2021-08-01 16:10:22 +00:00
Renovate Bot
32f0f90a7e
chore(deps): update dependency mkdocs to v1.2.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-26 19:41:59 +00:00
Renovate Bot
70801917bf
chore(deps): update dependency mkdocs-material to v7.2.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-26 18:19:05 +00:00
David Mehren
0f566c5ce7
[Docs] Add Mattermost guide to navigation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-07-18 10:02:17 +02:00
Renovate Bot
ac65de1348
chore(deps): update dependency mkdocs-material to v7.1.10 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-07-10 14:44:41 +00:00
Renovate Bot
f0110eae23
chore(deps): update dependency mkdocs-material to v7.1.9 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-25 10:53:38 +00:00
Renovate Bot
2125e9b98d
chore(deps): update dependency mkdocs-material to v7.1.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-12 14:17:30 +00:00
Renovate Bot
7dd0efa688
chore(deps): update dependency mkdocs to v1.2.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-09 17:35:54 +00:00
Renovate Bot
0a7d0a74fa
chore(deps): update dependency mkdocs to v1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-08 20:35:36 +00:00
David Mehren
5e771c2f65
Update Content Security Policy docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-06-07 22:57:12 +02:00
Renovate Bot
a3581c514b
chore(deps): update dependency mkdocs-material to v7.1.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-07 00:17:03 +00:00
Erik Michelson
df7a5e3f6c
Fix link in openapi doc 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2021-06-06 20:33:25 +02:00
Tilman Vatteroth
9a6d5d675a
Remove explicit title from cloudflare warning 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-06-03 23:24:09 +02:00
Yannick Bungers
23fa44cd36
Merge pull request #1346 from hedgedoc/add-cloudflare-warning-to-docs 
Add Cloudflare warning to the docs
 2021-06-03 20:43:46 +02:00
Tilman Vatteroth
ff12e3b23e
Add Cloudflare warning to the docs 
The cloudflare minify feature for HTML, CSS and JS breaks HedgeDoc.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-06-03 17:30:07 +02:00
Renovate Bot
4f592d32e2
chore(deps): update dependency mkdocs-material to v7.1.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-31 19:17:51 +00:00
Renovate Bot
b072da418d
chore(deps): update dependency mkdocs-material to v7.1.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-19 09:13:36 +00:00
David Mehren
32e31ac1e3
Bump version to 1.8.2 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-11 21:28:10 +02:00
Renovate Bot
1d5cd3cdc9
Update dependency pymdown-extensions to v8.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-08 17:26:14 +00:00
Philip Molares
a4b4ebd80c Docs: Add mention to install devDependencies 
Before `yarn build` can be succesfully run, we need to install the devDependencies.
This is necessary, because `bin/setup` does not install the devDependencies…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-05-08 13:47:31 +02:00
David Mehren
0555d01f4a
Bump version to 1.8.1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-06 22:24:02 +02:00
Renovate Bot
0ec7daf5f7
Update dependency mkdocs-material to v7.1.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-06 19:09:54 +00:00
David Mehren
e6d4ac5f9a
Remove mention of .sequelizerc from docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-03 22:26:08 +02:00
David Mehren
73e26e1d2d
Bump version to 1.8.0 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-03 22:26:08 +02:00
David Mehren
6cccc558e6
Bump version to 1.8.0-rc1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-26 21:42:03 +02:00
Renovate Bot
7d21e12d05
Update dependency mkdocs-material to v7.1.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-25 18:35:34 +00:00
David Mehren
2faf5b6974
Merge pull request #1150 from hedgedoc/feature/prometheus_metrics 2021-04-25 20:34:03 +02:00
David Mehren
cbe7b03b59
Document new Prometheus endpoint 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-25 20:06:56 +02:00
David Mehren
e1df30bd5c
Raise minimum required Node.js version to 12 
As Node 10 will be EOL at April 30th, we should stop supporting
and/or promoting the usage of that version.

See also https://endoflife.date/nodejs

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-22 22:52:38 +02:00
Renovate Bot
f697d6699a
Update dependency mkdocs-material to v7.1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-22 15:14:44 +00:00
Philip Molares
7192ec63f3 Docs: Revert changes to manual setup 
This reverts the documentation changes of bf0a7ebee7. This is necessary as the omitted remarks about `.sequlizerc` can't be omitted until 1.8 is released.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-04-22 13:31:12 +02:00
David Mehren
a15124ba35
Merge pull request #1145 from hedgedoc/docs/darkTheme 
Documentation: Add toggleable dark theme
 2021-04-18 22:50:50 +02:00
Philip Molares
60251d89ee
Documentation: Add toggleable dark theme 
The dark theme is mostly built on top of the mkdocs slate theme.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-04-18 22:44:02 +02:00
Yannick Bungers
58f5282ccb
Merge pull request #984 from hedgedoc/docs/upgrade-instructions 2021-04-17 16:33:49 +02:00
David Mehren
e8465aa8be
Docs: Fixup some wording in manual setup guide 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
c7104c94e4
Docs: Add hint about account creation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
70a289aeba
Docs: Include minimal config on manual setup page 
To make it easier to get started, this commit adds a minimal
`config.json` snipped to the manual setup instruction.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
87e0cea2f9
Docs: Cleanup docker page 
Build instructions are not relevant for most users.

Contact info can already be found on the 'Home' page.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
a3ee2c6f8c
Docs: Move migration hints to getting started page 
These are relevant for all installation methods, so they should be
placed at a 'global' place.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
2667b642f4
Docs: Include docker-compose snippet 
Directing users to use the container repo to install
HedgeDoc has caused upgrade-trouble in the past, after we made
incompatible changes to the docker-compose.yml in the repo.

This commit inserts a minimal docker-compose snipped in the
docs, which can be used to get started. Upgrading can then
be performed by just incrementing the referenced image version.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:11 +02:00
David Mehren
c54eef10a6
Add an example systemd unit to installation docs 
Heavily inspired by the unit of Arch Linux:
https://github.com/archlinux/svntogit-community/blob/packages/hedgedoc/trunk/hedgedoc.service

Fixes https://github.com/hedgedoc/hedgedoc/issues/46

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:18:35 +02:00
David Mehren
27d53f5233
Remove ancient migration docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:18:35 +02:00
David Mehren
3eb049e24b
Migrate container docs to main documentation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:18:33 +02:00
David Mehren
1f4388802b
Docs: Improve manual installation guide 
- Move the requirements into an info block
- Make clear that we use Yarn Classic
- Link to our downloads page instead of GitHub
- Simplify paragraph about configuring HedgeDoc
- Move additional information into `<small>` tags
- Match upgrade documentation to installation steps.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-15 21:52:58 +02:00
David Mehren
24dbc23ab0
Docs: Add a note about upgrading to the getting started guide 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-13 21:46:40 +02:00
Renovate Bot
8ad7108f6c
Update dependency mkdocs-material to v7.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-10 10:35:06 +00:00
Erik Michelson
185c50b25f
Replace codimd.org link with hedgedoc.org 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2021-04-08 21:43:48 +02:00
Yannick Bungers
572affdfb6
Merge pull request #1101 from hedgedoc/add-missing-mkdocs-plugin 2021-04-04 22:09:35 +02:00
Tilman Vatteroth
5218a4f07f
Fix emoji replacement in SAML docs 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-04-04 16:30:46 +02:00
Tilman Vatteroth
53e3a816b1
Add missing footnote mkdocs extension 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-04-03 21:15:18 +02:00
Tilman Vatteroth
4a0b00d0a6
Replace Unicode character with emoji shortcode 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-04-03 21:14:53 +02:00
Tilman Vatteroth
f355cfc864
[Docs] Add "HedgeDoc flavored markdown" page 
Co-authored-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-04-01 08:45:29 +02:00
Renovate Bot
53c83003ee
Update dependency mkdocs-material to v7.1.0 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-29 21:04:12 +00:00
Renovate Bot
48568d8ef4
Update dependency mkdocs-material to v7.0.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-28 14:19:17 +00:00
Renovate Bot
01bcfc499b
Update dependency mkdocs-material to v7.0.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-14 14:36:35 +00:00
Renovate Bot
7a6d9752bd
Update dependency mkdocs-material to v7.0.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-07 19:03:55 +00:00
David Mehren
bf0a7ebee7
Remove .sequelizerc 
After https://github.com/hedgedoc/hedgedoc/pull/969 was merged,
a separate configuration file for the sequelize-cli is no longer
required.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-06 10:34:22 +01:00
Renovate Bot
b70ce530ca
Update dependency mkdocs-material to v7.0.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-03-04 19:35:19 +00:00
David Mehren
b47f1e80b4
Add docs about troubleshooting migrations 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-03-03 12:38:44 +01:00
Renovate Bot
6798ee9056
Update dependency mkdocs-material to v7.0.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-26 16:07:38 +00:00
Renovate Bot
c97530fcf0
Update dependency mkdocs-material to v7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-25 19:10:35 +00:00
Tilman Vatteroth
ed9e74e68b
Fix link to sequelize database dialect docs 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-02-09 13:18:54 +01:00
Renovate Bot
4af6a8d302
chore(deps): update dependency pymdown-extensions to v8.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-05 11:46:59 +00:00
Renovate Bot
6972f19e79
chore(deps): update dependency mkdocs-material to v6.2.8 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-02-04 20:47:49 +00:00
Tilman Vatteroth
63b50651df
[Docs] Add "getting started" page 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-02-03 21:42:49 +01:00
Tilman Vatteroth
dc76d158e7
[Docs] Extend setup page with community methods 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-02-03 20:54:29 +01:00
Nicolas Dietrich
5e269e4af9 Keep JS and env varibale name in sync (requireFreeURLAuthentication) 
Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
 2021-01-23 14:14:47 +01:00
Nicolas Dietrich
497569fee4 Add config option which requires authentication in FreeURL mode 
This mitigates unintended note creation by bots or humans through a
simple GET call.

See discussion in #754.

Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
 2021-01-22 16:52:49 +01:00
Tilman Vatteroth
4d48ef1509
[Documentation] Fix link in manual setup 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-21 21:22:07 +01:00
Tilman Vatteroth
46eda5eead
Rewrite sentence 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-18 16:56:32 +01:00
Tilman Vatteroth
c1d9364a1a
Add page to setup namespace 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-18 16:51:03 +01:00
David Mehren
e9d4587344
Bump version to 1.7.2 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-15 20:37:30 +01:00
David Mehren
eaa7a15615
Docs: Reorder navigation links 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-13 20:59:32 +01:00
David Mehren
c8a7984fa4
Docs: Various formatting fixes 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-13 20:59:32 +01:00
David Mehren
1256eb3cd3
Docs: Use extensions to make markdown parsing more like GFM 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-13 20:59:32 +01:00
David Mehren
512fc2a914
GitLab Auth Guide: Fix indentation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 12:05:31 +01:00
David Mehren
bf7d4ddcd8
GitHub Auth Guide: Fix indentation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 12:04:56 +01:00
David Mehren
ee83c85eb0
SAML Auth Guide: Fix indentation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 12:03:48 +01:00
David Mehren
80d8cc79f6
Docs: Unify code block languages 
Use `yaml` for Dockerfiles, `shell` for environment variables and `json` for our config file.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 12:00:33 +01:00
David Mehren
877bc26078
Docs: Replace :smile with actual 😃 emoji 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 11:54:33 +01:00
David Mehren
1d92a81755
Docs: Enable SuperFences extension 
This allows indented code blocks in lists

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 11:54:33 +01:00
Simon C
6dab69de60
docs: Fix indentation of code 
(cherry picked from commit 4559d52d52)
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-01-11 11:12:57 +01:00
Tilman Vatteroth
5bdb392413
Several theme changes (#659) 
* Several theme changes

- Add max width of 1440px
- Rename css file
- Fix edit button
- Add local Roboto font

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-05 22:55:00 +01:00
Tilman Vatteroth
eaeb88401d
Move docs into subdirectory to make mkdocs work in a subdirectory 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2021-01-05 13:15:32 +01:00
David Mehren
fdc86538c6
Merge pull request #650 from hedgedoc/mkdocs 2021-01-04 18:35:08 +01:00
Philip Molares
90371c1c00 added documentation about how the write, build and deploy this 
documentation.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-04 14:26:39 +01:00
David Mehren
9f191bd58f
Merge pull request #646 from hedgedoc/kubernetes 2021-01-04 13:35:24 +01:00
Philip Molares
0911bf96e9 added all necessary configs to use structor 
see https://github.com/traefik/structor

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-03 22:15:12 +01:00
Philip Molares
dfa12e52e6 remove old documentation 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-03 16:10:27 +01:00
Philip Molares
55d653a1a2 started work on a mkdocs documentation for readthedocs.org 
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-03 16:00:25 +01:00
Philip Molares
d462675fc8 Update docs/setup/kubernetes.md 
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-02 16:14:22 +01:00
Philip Molares
d7ef5e83c2 changed kubernetes setup doc 
currently we don't provide our own and still linking to hackmd/codimd is
not helpful

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-01-02 11:01:34 +01:00
David Mehren
7d2c433b1b
Bump version to 1.7.1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-27 20:54:39 +01:00
aptalca
b9c043bf6b update linuxserver docker info 
Update badges and info to point to the newly published HedgeDoc image

Signed-off-by: aptalca <aptalca@linuxserver.io>
 2020-12-24 17:00:31 -05:00
Philip Molares
a41d9e4c11 Update configuration.md 
Added a more in depth example of how to set CMD_DB_URL or dbUrl

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-12-22 20:32:27 +01:00
ericgaspar
8dc215fd98
Set Install-with-yunohost bagde to SVG 
Signed-off-by: ericgaspar <junk.eg@free.fr>
 2020-12-21 23:28:56 +01:00
David Mehren
faf3010c39
Bump version to 1.7.0 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-21 21:36:40 +01:00
David Mehren
22d2bf00fc
Fix typo in reverse proxy docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-13 19:09:41 +01:00
David Mehren
2f5ca84605
Document reverse proxy config for Apache 
As we found out in #616, Apache does not set the `X-Forwarded-Proto` header, which is now required because we switched to secure cookies in 383d791a50.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-13 19:09:34 +01:00
David Mehren
2338a98731
Merge pull request #613 from nidico/patch-1 
Fix some typos in history.md
 2020-12-03 22:18:50 +01:00
David Mehren
81e463250d
Release 1.7.0-rc2 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-02 23:15:56 +01:00
Nicolas Dietrich
0195d074a8
Fix some typos in history.md 2020-12-01 00:32:48 +01:00
ericgaspar
d1a0ca05af
Update yunohost.md 
Signed-off-by: ericgaspar <junk.eg@free.fr>

Upgrade YunoHost doc link

Signed-off-by: ericgaspar <junk.eg@free.fr>
 2020-11-30 14:16:10 +01:00
David Mehren
9caaaf48e3
Bump Version to 1.7.0-rc1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-29 15:59:23 +01:00
David Mehren
a5d835cb74
Merge pull request #597 from hedgedoc/fix/install-docs 2020-11-29 15:51:43 +01:00
David Mehren
c83c6cb226
Document that Git can also be used to checkout releases. 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
7bcf548cd2
Mention that the database connection string needs an absolute path to the SQLite file 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
b78a58c0a9
Update manual install docs for 1.7 
Starting with 1.7, releases include the frontend bundle.
This commit updates the docs accordingly.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
61f54db63e
Merge pull request #596 from hedgedoc/remove-pdf-export-code 
Remove pdf export code
 2020-11-27 18:31:19 +01:00
Yannick Bungers
8f7e11f780
Merge pull request #595 from joachimmathes/oauth2_authorization 
Add oauth2 authorization roles
 2020-11-27 09:09:29 +01:00
Tilman Vatteroth
97312b5ed3
Remove pdf export code 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-26 21:09:23 +01:00
Joachim Mathes
729b387536 Add oauth2 authorization 
Signed-off-by: Joachim Mathes <joachim_mathes@web.de>
 2020-11-25 19:23:55 +01:00
Nils VAN ZUIJLEN
3449a85e4d
Replace nGinx by Nginx 
Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
 2020-11-18 18:39:31 +01:00
Nils VAN ZUIJLEN
379cff97d9
Add documentation for reverse-proxy use 
Fixes #256

Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
 2020-11-18 16:29:18 +01:00
Erik Michelson
938d39495f
Updated screenshot 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2020-11-17 11:13:58 +01:00
Tilman Vatteroth
9898ab3ca5
Rename image file 2020-11-15 20:37:56 +01:00
Tilman Vatteroth
f37d890c65
Replace hedgedoc logo with horizontal 2020-11-15 20:37:01 +01:00
Tilman Vatteroth
243046e620
Rename image 2020-11-15 20:35:05 +01:00
Tilman Vatteroth
ad15c607db
Resize hedgedoc logo for readme 2020-11-15 20:33:15 +01:00
Tilman Vatteroth
b600f7fb4a
Resize readme image 2020-11-15 20:30:46 +01:00
Tilman Vatteroth
762376b925
Replace image in readme 2020-11-15 20:29:44 +01:00
Tilman Vatteroth
4688eec853
change images in docs auth github 2020-11-15 20:24:05 +01:00
mrdrogdrog
d10c13e842
Update docs/configuration.md 
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
 2020-11-15 20:03:09 +01:00
mrdrogdrog
2e3d915927
Update docs/setup/docker.md 
Co-authored-by: Philip Molares <git@molar.es>
 2020-11-15 13:19:59 +01:00
mrdrogdrog
5aeec761e2
Update docs/setup/docker.md 
Co-authored-by: Philip Molares <git@molar.es>
 2020-11-15 13:19:50 +01:00
mrdrogdrog
03795cbf7b
Update docs/guides/auth/keycloak.md 
Co-authored-by: Philip Molares <git@molar.es>
 2020-11-15 13:19:39 +01:00
Sheogorath
d2e4afb77e
Update history.md 2020-11-15 12:46:19 +01:00
mrdrogdrog
8b8f8b4582
Update docs/guides/migrations-and-breaking-changes.md 
Co-authored-by: Philip Molares <git@molar.es>
 2020-11-15 12:34:08 +01:00
Tilman Vatteroth
0c6a420e75
Reword history text 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-14 23:14:01 +01:00
Tilman Vatteroth
c3fccfc385
Insert history text 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-14 22:37:42 +01:00
Tilman Vatteroth
1d91979540
Revert incomplete text 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-14 22:26:25 +01:00
Tilman Vatteroth
978538c0de
Correct repo name 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-14 22:24:44 +01:00
Tilman Vatteroth
2fffe04b01
Replace screenshot in readme 
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
 2020-11-14 21:59:15 +01:00
Erik Michelson
b28839484d
Replace CodiMD with HedgeDoc 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in public/views

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in README

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in SECURITY.md

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in LICENSE

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in docs/configuration.md

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in bin/setup

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/guides

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/dev

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/guides/auth

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/setup

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update various links in code to the new GitHub org.

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/setup/yunohost

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rebrand to HedgeDoc: Add banner and logo

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Remove note in docs/guides/auth/github

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace links in public/docs/features

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add todo placeholder in docs/history

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace github link in public/views/index/body

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace github link in README

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add logo to README

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add note about the renaming to the front page

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Removed Travis from README.md and change CodiMD to HedgeDoc in some places

Signed-off-by: Yannick Bungers <git@innay.de>

Some more renaming to HedgeDoc
- Fixed capitalization of HedgeDoc
- Added renaming for etherpad migration doc

Signed-off-by: Yannick Bungers <git@innay.de>

Changed Repo name to hedgedoc

Signed-off-by: Yannick Bungers <git@innay.de>
 2020-11-14 21:18:36 +01:00
David Mehren
299301f0fe
Merge pull request #567 from codimd/fix/manual-setup-doc 
Fixed inconsistencies in documentation
 2020-11-13 17:18:32 +01:00
David Mehren
7560943a44
Merge pull request #499 from pierreozoux/convenience-script 
Adds convenience script to migrate to minio.
 2020-11-13 17:17:17 +01:00
pierreozoux
47427a1b88 Adds convenience script to migrate to minio. 
Signed-off-by: pierreozoux <pierre@ozoux.net>
 2020-11-12 21:14:27 +01:00
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
Éric Gaspar
72cb67883c
Update configuration.md 
Minor formatting typo

Signed-off-by: ericgaspar <junk.eg@free.fr>
 2020-10-11 13:43:40 +02:00
Erik Michelson
4ece86f0ef
Update documentation and messages to new default value 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2020-09-08 09:58:15 +02:00
Erik Michelson
824f910bfe
Add config option for cookie SameSite policy 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2020-08-27 02:04:49 +02: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
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
Sheogorath
7cde6958f3
Update links to new repositories 
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>
 2019-03-27 19:31:34 +01:00
Felix Yan
1ccadec5a3 Fix several typos in auth/saml.md 
Signed-off-by: Felix Yan <felixonmars@archlinux.org>
 2019-02-15 04:14:17 +08:00