diff --git a/README.md b/README.md index 0af7c7f4..38567de7 100644 --- a/README.md +++ b/README.md @@ -81,11 +81,12 @@ The current stable release (2.x) is available at https://js.wiki ### Usage -1. Clone the project -1. Open the project in VS Code +1. Clone the project. +1. Open the project in VS Code. 1. Make sure you have **Dev Containers** extension installed. (On Windows, you need the **WSL** VS Code extension as well.) 1. Reopen the project in container (from the popup in the lower-right corner of the screen when opening the project, or via the Command Palette (Ctrl+Shift+P) afterwards). -1. Once in container mode, run the task "Create terminals" from the Command Palette: +1. Once in container mode, make a copy of `config.sample.yml` and rename it to `config.yml`. There's no need to edit the file, the default values are ok. +1. From the Command Palette, run the task "Create terminals": - Launch the Command Palette (Ctrl+Shift+P) - Type "Run Task" and press Enter - Select the task "Create terminals" and press Enter diff --git a/config.sample.yml b/config.sample.yml index 3ad33b5b..d3adaf89 100644 --- a/config.sample.yml +++ b/config.sample.yml @@ -2,7 +2,7 @@ # Wiki.js - CONFIGURATION # ####################################################################### # Full documentation + examples: -# https://docs.js.wiki/install +# https://js.wiki/docs/install # --------------------------------------------------------------------- # Port the server should listen to @@ -13,14 +13,14 @@ port: 3000 # --------------------------------------------------------------------- # Database # --------------------------------------------------------------------- -# PostgreSQL 9.6 or later required +# PostgreSQL 11 or later required db: host: localhost port: 5432 - user: wikijs - pass: wikijsrocks - db: wiki + user: postgres + pass: postgres + db: postgres schemas: wiki: wiki scheduler: scheduler