Document that Git can also be used to checkout releases.

Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2020-11-27 21:22:32 +01:00
parent 7bcf548cd2
commit c83c6cb226
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3

View file

@ -19,9 +19,10 @@
1. Check if you meet the [requirements at the top of this document](#requirements-on-your-server).
2. Download a [release](https://github.com/hedgedoc/hedgedoc/releases) tarball and extract it.
Alternatively, you can use Git to clone the repository and checkout a release, e.g. with `git clone -b 1.7.0 https://github.com/hedgedoc/hedgedoc.git`.
3. Enter the directory and type `bin/setup`, which will install the dependencies and create configs.
4. Modify the file named `config.json` or configure HedgeDoc through environment variables which will overwrite the configs, see docs [here](https://github.com/hedgedoc/hedgedoc/blob/master/docs/configuration.md).
5. **Skip this step for release 1.7 and newer!**
5. **If using the release tarball for 1.7.0 or newer, this step can be skipped.**
Build the frontend bundle by `yarn run build` (use `yarn run dev` if you are in development)
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`