diff options
Diffstat (limited to 'docs/content/setup/manual-setup.md')
| -rw-r--r-- | docs/content/setup/manual-setup.md | 14 |
1 files changed, 5 insertions, 9 deletions
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`. |