Commit graph

53 commits

Author SHA1 Message Date
Sheogorath
ddf08cfb96 chore: Drop twitter from docs
It seems except of the documentation for auth providers, this should be
everything regarding Twitter.

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2023-12-22 23:00:00 +01:00
David Mehren
f52475dc4f Bump version to 1.9.9
Signed-off-by: David Mehren <git@herrmehren.de>
2023-07-30 20:07:27 +02:00
David Mehren
57c2865224 Bump version to 1.9.8
Signed-off-by: David Mehren <git@herrmehren.de>
2023-06-04 21:35:20 +02:00
David Mehren
3542a0304c Update setup docs and setup script for Yarn 3
Signed-off-by: David Mehren <git@herrmehren.de>
2023-06-03 12:09:40 +02:00
David Mehren
7b3b6ad7ac Update supported node versions in docs
Signed-off-by: David Mehren <git@herrmehren.de>
2023-05-29 11:23:21 +02:00
Tilman Vatteroth
cd83499bc0 chore: drop support for node 14
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-05-14 21:12:48 +02:00
David Mehren
d4f19e4e38
Bump version to 1.9.7
Signed-off-by: David Mehren <git@herrmehren.de>
2023-02-19 21:46:50 +01:00
Philip Molares
5b88437aa8 docs(setup): add freebsd ports to Community -> Distribution Packages
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2023-01-23 22:49:55 +01:00
David Mehren
6bad318c35 Bump version to 1.9.6
Signed-off-by: David Mehren <git@herrmehren.de>
2022-11-06 23:10:59 +01:00
David Mehren
50cac714ce Bump version and update release notes
Signed-off-by: David Mehren <git@herrmehren.de>
2022-10-30 22:15:16 +01:00
Tilman Vatteroth
98e9616af8 fix(docs): Add a note that node 18 is not supported
Node 18 is not supported because of dependency problems. It's already covered by the package.json but not by the docs.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-09-30 08:53:43 +02:00
David Mehren
90d5f3ab04
Bump version to 1.9.4
Signed-off-by: David Mehren <git@herrmehren.de>
2022-07-10 22:02:17 +02:00
Erik Michelson
8c15e961b2
fix(docs): deployment url for manual setup
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-07-10 22:02:16 +02:00
Erik Michelson
45137515a6 fix(docs): title case, community page improvements
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-05-18 10:41:27 +02:00
Philip Molares
fbf3100829 docs: consolidate community install methods
Add all community install methods to a single page. This seems to be a better option as all of these methods have very little to document and this makes it easier to browse through the different methods.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2022-05-18 10:41:27 +02:00
Manu
b4cf434179 Add PikaPods as additional deployment option.
Full name: Manuel Riel

Signed-off-by: Manu <manu@snapdragon.cc>
2022-05-07 20:42:37 +02:00
David Mehren
e222225866 Drop support for Node.js 12
Signed-off-by: David Mehren <git@herrmehren.de>
2022-05-01 21:03:19 +02:00
Sheogorath
3d7bf464d9
docs(manual): Adjust instructions to use only pinned dependencies
This patch adds `--frozen-lockfile` to our regular `yarn install` calls
during manual set up. This should ensure people get the expected
versions and not any newer or older versions that might behave
unexpectedly.

References:
https://github.com/yarnpkg/yarn/issues/5847#issuecomment-537521943
https://classic.yarnpkg.com/en/docs/cli/install#toc-yarn-install-frozen-lockfile

Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>
2022-04-12 20:16:33 +02:00
David Mehren
836bda0f85
Bump version to 1.9.3
Signed-off-by: David Mehren <git@herrmehren.de>
2022-04-10 21:49:36 +02:00
Erik Michelson
bbb61036c8 Use localhost instead of 127.0.0.1 in docker guide
The example docker-compose.yml in the docker guide sets CMD_DOMAIN to
localhost. This results in HedgeDoc only being startable from
http://localhost:3000 as the Content-Security-Policy forbids access
to e.g. http://127.0.0.1:3000. Despite that the docs used 127.0.0.1
for linking to the instance prior to this commit.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2022-02-14 15:38:33 +01:00
David Mehren
1a0e6e8ae8
Bump version to 1.9.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-03 20:33:53 +01:00
David Mehren
ece1bb8d56
Update Node requirements in manual setup guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-02 22:32:32 +01:00
Tilman Vatteroth
3d05aac2d5
Bump version to 1.9.1
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
Signed-off-by: David Mehren <git@herrmehren.de>
2021-12-02 22:14:54 +01:00
Danilo Bargen
74d7fc06f3 Docs: Document UPLOADS_MODE env var for Docker image
Signed-off-by: Danilo Bargen <mail@dbrgn.ch>
2021-11-24 22:51:06 +01: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
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
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
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
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
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
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
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
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
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
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
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
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
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