summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDavid Mehren2021-05-03 22:49:15 +0200
committerGitHub2021-05-03 22:49:15 +0200
commitf48e36d2052bcae56081bee3c281bfc69fe7f70d (patch)
treea0bbc5dd84230bb2dcc92a7e297b9ff2cca9f0d4 /docs
parent9d08eaec8fe4ec3b62be7a7a116c01557b1e6a11 (diff)
parente6d4ac5f9a50b28b9d6e456d7fc343194ab1cbee (diff)
Merge pull request #1219 from hedgedoc/release/1.8.0
Diffstat (limited to 'docs')
-rw-r--r--docs/content/dev/openapi.yml2
-rw-r--r--docs/content/setup/docker.md2
-rw-r--r--docs/content/setup/manual-setup.md14
3 files changed, 7 insertions, 11 deletions
diff --git a/docs/content/dev/openapi.yml b/docs/content/dev/openapi.yml
index cd62b48a..1a734451 100644
--- a/docs/content/dev/openapi.yml
+++ b/docs/content/dev/openapi.yml
@@ -3,7 +3,7 @@ openapi: 3.0.1
info:
title: HedgeDoc
description: HedgeDoc is an open source collaborative note editor. Several tasks of HedgeDoc can be automated through this API.
- version: 1.8.0-rc1
+ version: 1.8.0
contact:
name: HedgeDoc on GitHub
url: https://github.com/hedgedoc/hedgedoc
diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md
index 11ff9b02..bc8b3ac9 100644
--- a/docs/content/setup/docker.md
+++ b/docs/content/setup/docker.md
@@ -28,7 +28,7 @@ services:
restart: always
app:
# Make sure to use the latest release from https://hedgedoc.org/latest-release
- image: quay.io/hedgedoc/hedgedoc:1.7.2
+ image: quay.io/hedgedoc/hedgedoc:1.8.0
environment:
- CMD_DB_URL=postgres://hedgedoc:password@database:5432/hedgedoc
- CMD_DOMAIN=localhost
diff --git a/docs/content/setup/manual-setup.md b/docs/content/setup/manual-setup.md
index 64ad57c5..26882ba2 100644
--- a/docs/content/setup/manual-setup.md
+++ b/docs/content/setup/manual-setup.md
@@ -16,7 +16,7 @@
1. Check if you meet the [requirements at the top of this document](#manual-installation).
2. Download the [latest release](https://hedgedoc.org/latest-release/) and extract it.
- <small>Alternatively, you can use Git to clone the repository and checkout a release, e.g. with `git clone -b 1.7.2 https://github.com/hedgedoc/hedgedoc.git`.</small>
+ <small>Alternatively, you can use Git to clone the repository and checkout a release, e.g. with `git clone -b 1.8.0 https://github.com/hedgedoc/hedgedoc.git`.</small>
3. Enter the directory and execute `bin/setup`, which will install the dependencies and create example configs.
4. Configure HedgeDoc: To get started, you can use this minimal `config.json`:
```json
@@ -35,18 +35,14 @@
For details, have a look at [the configuration documentation](../configuration.md).
5. *:octicons-light-bulb-16: If you use the release tarball for 1.7.0 or newer, this step can be skipped.*
Build the frontend bundle by running `yarn run build`.
-6. Modify the file named `.sequelizerc`, change the value of the variable `url` to your db connection string. For example:
- - `postgres://username:password@localhost:5432/hedgedoc`
- - `mysql://username:password@localhost:3306/hedgedoc`
- - `sqlite:///opt/hedgedoc/hedgedoc.sqlite` (note that you need to use an absolute path to the SQLite file)
-7. It is recommended to start your server manually once:
+6. It is recommended to start your server manually once:
```shell
NODE_ENV=production yarn start
```
This way it's easier to see warnings or errors that might occur.
<small>You can leave out `NODE_ENV=production` for development.</small>
-8. If you use the example config, HedgeDoc should now be available at [http://127.0.0.1:3000](http://127.0.0.1:3000).
-9. Run the server as you like (node, forever, pm2, systemd, Init-Scripts).
+7. If you use the example config, HedgeDoc should now be available at [http://127.0.0.1:3000](http://127.0.0.1:3000).
+8. Run the server as you like (node, forever, pm2, systemd, Init-Scripts).
See [below](#systemd-unit-example) for an example using systemd.
## Upgrading
@@ -62,7 +58,7 @@ If you want to upgrade HedgeDoc from an older version, follow these steps:
and the latest release.
2. Fully stop your old HedgeDoc server.
3. [Download](https://hedgedoc.org/latest-release/) the new release and extract it over the old directory.
- <small>If you use Git, you can check out the new tag with e.g. `git fetch origin && git checkout 1.7.2`</small>
+ <small>If you use Git, you can check out the new tag with e.g. `git fetch origin && git checkout 1.8.0`</small>
5. Run `bin/setup`. This will take care of installing dependencies. It is safe to run on an existing installation.
6. *:octicons-light-bulb-16: If you used the release tarball for 1.7.0 or newer, this step can be skipped.*
Build the frontend bundle by running `yarn run build`.